Interface PagedAsyncIterableIterator<TElement, TPage, TPageSettings>

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

interface PagedAsyncIterableIterator<
    TElement,
    TPage = TElement[],
    TPageSettings = PageSettings,
> {
    "[asyncIterator]": () => PagedAsyncIterableIterator<
        TElement,
        TPage,
        TPageSettings,
    >;
    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
    next: () => Promise<IteratorResult<TElement, any>>;
}

Type Parameters

TElement
TPage = TElement[]
TPageSettings = PageSettings

Index

Properties

[asyncIterator] byPage next

Properties

[asyncIterator]

"[asyncIterator]": () => PagedAsyncIterableIterator<
    TElement,
    TPage,
    TPageSettings,
>

The connection to the async iterator, part of the iteration protocol

byPage

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

Return an AsyncIterableIterator that works a page at a time

next

next: () => Promise<IteratorResult<TElement, any>>

The next method, part of the iteration protocol