Function: paginate()

function paginate<TItem, TBody>(fetchPage, body, opts?): Paginator<TItem>;

Wrap a search operation as a lazy, cancelable async stream.

Type Parameters

TItem

TItem

TBody

TBody extends SearchBody

Parameters

fetchPage

FetchPage<TItem, TBody>

body

TBody

opts?

PaginateOptions = {}

Returns

Paginator<TItem>

Example

const p = paginate((b, s) => searchProcessInstances(b, { ... }), body); for await (const pi of p.items()) { ... } // item-by-item for await (const page of p.pages()) { ... } // page-by-page