retort

v2.7.0

retort v2.7.0 Retort.Client.Stream View Source

Streams the resources from all the pages available on an Retort.Client.index/3.

Link to this section Summary

Types

t()

The internal state of stream produced by new/3

Functions

new(pid, params \\ %{}, timeout \\ 5000)

A new stream of pid’s Retort.Client.index/3 starting with the given params and timeout for each request

Link to this section Types

Link to this type t() View Source 
t() :: %Retort.Client.Stream{pagination: Alembic.Pagination.t(), params: map(), pid: pid(), timeout: timeout()}

The internal state of stream produced by new/3.

  • params - the params passed to Retort.Client.index/3. After the initial call, "page[number]" and "page[size]" will be overridden with the Alembic.Pagination.t next Alembic.Pagination.Page.t number and size.
  • pid - the pid of an Retort.Client
  • timeout - the timeout for each Retort.Client.index/3 call

Link to this section Functions

Link to this function new(pid, params \\ %{}, timeout \\ 5000) View Source 
new(pid(), map(), timeout()) :: Enumerable.t()

A new stream of pid’s Retort.Client.index/3 starting with the given params and timeout for each request.