Interface: Paginator<TItem>

Extends

• AsyncIterable<SearchResponse<TItem>>

Type Parameters

TItem

TItem

Methods

items()

items(): AsyncGenerator<TItem, void, void>;

Yields individual items across all pages (yield*-flattened).

Returns

AsyncGenerator<TItem, void, void>

---

pages()

pages(): AsyncGenerator<SearchResponse<TItem>, void, void>;

Yields whole pages, fetching each lazily as it is consumed.

Returns

AsyncGenerator<SearchResponse<TItem>, void, void>

---

toArray()

toArray(): Promise<TItem[]>;

Eagerly drains every item into an array. Bounded result sets only.

Returns

Promise<TItem[]>