Package version:

Interface PagedAsyncIterableIterator<TElement, TPage, TPageSettings>

An interface that allows async iterable iteration both to completion and by page.

interface PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {
byPage: ((settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>);
next(): Promise<IteratorResult<TElement>>;
}

Type Parameters

TElement
TPage = TElement[]
TPageSettings extends PageSettings = PageSettings

Index

Properties

Methods

Properties

byPage

byPage: ((settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>)

Return an AsyncIterableIterator that works a page at a time

Methods

next

next(): Promise<IteratorResult<TElement>>
The next method, part of the iteration protocol

Returns Promise<IteratorResult<TElement>>
- Defined in static-helpers/pagingHelpers.ts:38