Interface Paginator<TItem>

interface Paginator<TItem> {
    items(): AsyncGenerator<TItem, void, void>;
    pages(): AsyncGenerator<SearchResponse<TItem>, void, void>;
    toArray(): Promise<TItem[]>;
}

Type Parameters

TItem

Hierarchy

AsyncIterable<SearchResponse<TItem>>
- Paginator

Index

Methods

items pages toArray

Methods

items

items(): AsyncGenerator<TItem, void, void>
Yields individual items across all pages (yield*-flattened).

Returns AsyncGenerator<TItem, void, void>
- Defined in src/runtime/pagination.ts:74

pages

pages(): AsyncGenerator<SearchResponse<TItem>, void, void>
Yields whole pages, fetching each lazily as it is consumed.

Returns AsyncGenerator<SearchResponse<TItem>, void, void>
- Defined in src/runtime/pagination.ts:72

toArray

toArray(): Promise<TItem[]>
Eagerly drains every item into an array. Bounded result sets only.

Returns Promise<TItem[]>
- Defined in src/runtime/pagination.ts:76