PagedAsyncIterableIterator interface

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

Properties

byPage

Return an AsyncIterableIterator that works a page at a time

Methods

next()

The next method, part of the iteration protocol

[asyncIterator]()

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

Property Details

byPage

Return an AsyncIterableIterator that works a page at a time

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

Property Value

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

Method Details

next()

The next method, part of the iteration protocol

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

Returns

Promise<IteratorResult<TElement, any>>

[asyncIterator]()

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

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

Returns

PagedAsyncIterableIterator<TElement, TPage, TPageSettings>