chalk_elixir
chalk_elixir v0.0.12

View Source Chalk.Client.Request (chalk_elixir v0.0.12)

Data structure for an HTTP request with convenience functions.

Link to this section Summary

Types

t()

Functions

add_metadata(request, config \\ %{})

Add telemetry metadata to Request. Calling without the second argument adds default metadata. Custom metadata is added by passing a map with a key telemetry_metadata. Example

to_options(request)

Convert Request to options format passed to Tesla.request/2.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Chalk.Client.Request{
  body: map(),
  endpoint: String.t(),
  method: atom(),
  opts: map()
}

Link to this section Functions

Link to this function

add_metadata(request, config \\ %{})

View Source 
@spec add_metadata(t(), map()) :: t()

Add telemetry metadata to Request. Calling without the second argument adds default metadata. Custom metadata is added by passing a map with a key telemetry_metadata. Example

Request.add_metadata(request, %{telemetry_metadata: %{k: v}})
Link to this function

to_options(request)

View Source 
@spec to_options(t()) :: keyword()

Convert Request to options format passed to Tesla.request/2.