Supabase.Fetcher.Behaviour behaviour (supabase_potion v0.6.1)

Defines Supabase HTTP Clients callbacks

Summary

Types

on_response()

The response handler for streaming responses. It receives the response status, headers, and body as input.

on_response_input()

Callbacks

request(t)

request_async(t)

stream(t)

stream(t, on_response)

upload(t, filepath)

Types

on_response()

@type on_response() :: (on_response_input() ->
                    :ok | {:ok, term()} | {:error, Supabase.Error.t()})

The response handler for streaming responses. It receives the response status, headers, and body as input.

Note that here only the status and headers are consumed from the stream and so the body reamins unconsumed for custom operations, receiving each chunk of the body as it arrives.

It needs to return either :ok or {:ok, body} or {:error, Supabase.Error}.

on_response_input()

@type on_response_input() ::
  {Supabase.Fetcher.status(), Supabase.Fetcher.headers(),
   body :: Enumerable.t()}

Callbacks

request(t)

@callback request(Supabase.Fetcher.Request.t()) ::
  Supabase.result(Supabase.Fetcher.Response.t())

request_async(t)

@callback request_async(Supabase.Fetcher.Request.t()) ::
  Supabase.result(Supabase.Fetcher.Response.t())

stream(t)

@callback stream(Supabase.Fetcher.Request.t()) ::
  Supabase.result(Supabase.Fetcher.Response.t())

stream(t, on_response)

@callback stream(Supabase.Fetcher.Request.t(), on_response()) ::
  Supabase.result(Supabase.Fetcher.Response.t())

upload(t, filepath)

@callback upload(Supabase.Fetcher.Request.t(), filepath :: Path.t()) ::
  Supabase.result(Supabase.Fetcher.Response.t())