sanity v1.1.1

View Source Sanity.Behaviour behaviour (sanity v1.1.1)

Behaviour implemented by the Sanity module. This behaviour includes all functions that make requests to the Sanity API. Pure functions from the Sanity module are not included. This behaviour is useful for creating mocks using the Mox library.

Link to this section Summary

Callbacks

request(t, keyword)
request!(t, keyword)
stream(t)

Link to this section Callbacks

Link to this callback

request(t, keyword)

View Source 
@callback request(
  Sanity.Request.t(),
  keyword()
) :: {:ok, Sanity.Response.t()} | {:error, Sanity.Response.t()}
Link to this callback

request!(t, keyword)

View Source 
@callback request!(
  Sanity.Request.t(),
  keyword()
) :: Sanity.Response.t()
Link to this callback

stream(t)

View Source 
@callback stream(Keyword.t()) :: Enumerable.t()