CPub v0.3.0

CPub.HTTP.RequestBuilder (CPub v0.3.0) View Source

Helper functions for building Tesla requests.

Link to this section Summary

Functions

add_param(request, location, key, values)

Add optional parameters to the request

convert_to_keyword(request)
headers(request, headers)

Add headers to the request

method(request, method)

Specify the request method when building a request

new(request \\ %Request{})

Creates new request

opts(request, options)

Add custom, per-request middleware or adapter options to the request

url(request, url)

Specify the request method when building a request

Link to this section Functions

Link to this function

add_param(request, location, key, values)

View Source

Specs

add_param(CPub.HTTP.Request.t(), atom(), atom(), any()) :: CPub.HTTP.Request.t()

Add optional parameters to the request

Link to this function

convert_to_keyword(request)

View Source

Specs

convert_to_keyword(CPub.HTTP.Request.t()) :: keyword()
Link to this function

headers(request, headers)

View Source

Specs

headers(CPub.HTTP.Request.t(), CPub.HTTP.Request.headers()) ::
  CPub.HTTP.Request.t()

Add headers to the request

Link to this function

method(request, method)

View Source

Specs

method(CPub.HTTP.Request.t(), CPub.HTTP.Request.method()) ::
  CPub.HTTP.Request.t()

Specify the request method when building a request

Link to this function

new(request \\ %Request{})

View Source

Specs

new(CPub.HTTP.Request.t()) :: CPub.HTTP.Request.t()

Creates new request

Link to this function

opts(request, options)

View Source

Specs

opts(
  CPub.HTTP.Request.t(),
  keyword()
) :: CPub.HTTP.Request.t()

Add custom, per-request middleware or adapter options to the request

Link to this function

url(request, url)

View Source

Specs

url(CPub.HTTP.Request.t(), CPub.HTTP.Request.url()) :: CPub.HTTP.Request.t()

Specify the request method when building a request