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

TElement
TPage = TElement[]
TPageSettings = PageSettings

Index

Properties

Methods

[asyncIterator] next

Properties

byPage

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

Return an AsyncIterableIterator that works a page at a time

Methods

[asyncIterator]

"[asyncIterator]"(): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>
The connection to the async iterator, part of the iteration protocol

Returns PagedAsyncIterableIterator<TElement, TPage, TPageSettings>
- Defined in packages/azure-mock/src/models/PagedAsyncIterableIterator.ts:9

next

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

Returns Promise<IteratorResult<TElement, any>>
- Defined in packages/azure-mock/src/models/PagedAsyncIterableIterator.ts:17