paginate

paginate<T>(fetchPage, params?): AsyncGenerator<T, void, undefined>

Defined in: packages/core/src/pagination.ts:22

Drive a cursor-paginated endpoint as an async iterator.

Type Parameters

T

T

Parameters

fetchPage

(params) => Promise<CursorPage<T>>

params?

Omit<CursorPaginationParams, "cursor"> = {}

Returns

AsyncGenerator<T, void, undefined>

Example

for await (const order of paginate((p) => client.orders.list(p))) {
  console.log(order.id);
}