Tink.HTTP.Behaviour behaviour (Tink v1.0.0)

Copy Markdown View Source

Behaviour for HTTP adapters — swap Finch for test mocks.

Summary

Types

body()
headers()
method()
response()

Callbacks

request(method, t, headers, body, keyword)

Types

body()

@type body() :: String.t() | nil

headers()

@type headers() :: [{String.t(), String.t()}]

method()

@type method() :: :get | :post | :put | :patch | :delete

response()

@type response() ::
  {:ok, %{status: integer(), headers: headers(), body: String.t()}}
  | {:error, term()}

Callbacks

request(method, t, headers, body, keyword)

@callback request(method(), String.t(), headers(), body(), keyword()) :: response()