WorkOS.Page (WorkOS SDK for Elixir v3.0.1)

A single page of results with lazy auto-pagination.

Use WorkOS.Page.stream/1 to lazily iterate every item across all pages.

Summary

t(item)

The cursor for the next page, or nil when this is the last page.

has_more?(page)

Whether another page is available.

stream(page)

Lazily streams every item across all pages, fetching pages on demand.

@type t(item) :: %WorkOS.Page{
  data: [item],
  fetch_next: (String.t() -> {:ok, t(item)} | {:error, term()}) | nil,
  list_metadata: map() | nil
}

@spec after_cursor(t(term())) :: String.t() | nil

The cursor for the next page, or nil when this is the last page.

@spec has_more?(t(term())) :: boolean()

Whether another page is available.

@spec stream(t(item)) :: Enumerable.t() when item: term()

Lazily streams every item across all pages, fetching pages on demand.

Stops if a page fetch fails; use explicit pagination when you need to distinguish errors from the end of the collection.