paginateOffset

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

Defined in: packages/core/dist/index.d.ts:142

Drive an offset-paginated endpoint as an async iterator. Stops when the server’s pageCount is exhausted (or after the configured maxPages to bound runaway iteration). Default page size is whatever the underlying endpoint clamps to — pass limit explicitly for control.

Type Parameters

T

T

Parameters

fetchPage

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

params?

limit?

number

maxPages?

number

Returns

AsyncGenerator<T, void, undefined>

Example

for await (const order of paginateOffset((p) =>
  client.orders.list(p),
)) {
  console.log(order.orderNumber);
}