Esposter
    Preparing search index...

    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,
    > {
        byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
        "[asyncIterator]"(): PagedAsyncIterableIterator<
            TElement,
            TPage,
            TPageSettings,
        >;
        next(): Promise<IteratorResult<TElement, any>>;
    }

    Type Parameters

    Index

    Properties

    Methods

    Properties

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

    Return an AsyncIterableIterator that works a page at a time

    Methods

    • The next method, part of the iteration protocol

      Returns Promise<IteratorResult<TElement, any>>