Kadena v0.19.0

View Source Kadena.Chainweb.Client.Spec behaviour (Kadena v0.19.0)

Specifies expected behaviour of an HTTP client.

Kadena allows you to use your HTTP client of choice, provided that it can be coerced into complying with this module's specification. The default is :hackney.

Link to this section Summary

Types

body()
headers()
method()
options()
response()
response_error()
status()

Callbacks

request(method, url, headers, body, options)

Link to this section Types

Link to this type

body()

View Source 
@type body() :: binary()
Link to this type

headers()

View Source 
@type headers() :: [{binary(), binary()}, ...]
Link to this type

method()

View Source 
@type method() :: :get | :post | :put | :delete
Link to this type

options()

View Source 
@type options() :: Keyword.t()
Link to this type

response()

View Source 
@type response() :: {:ok, map()}
Link to this type

response_error()

View Source 
@type response_error() :: {:error, Kadena.Chainweb.Error.t()}
Link to this type

status()

View Source 
@type status() :: non_neg_integer()

Link to this section Callbacks

Link to this callback

request(method, url, headers, body, options)

View Source 
@callback request(
  method :: method(),
  url :: binary(),
  headers :: headers(),
  body :: binary(),
  options :: options()
) :: response() | response_error()