@azure/core-paging package

Interfaces

PageSettings	An interface that tracks the settings for paged iteration
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PagedResult	An interface that describes how to communicate with the service.

Type Aliases

Paged

Paged collection of T items

Functions

getPagedAsyncIterator<TElement, TPage, TPageSettings, TLink>(PagedResult<TPage, TPageSettings, TLink>)

returns an async iterator that iterates over results. It also has a byPage method that returns pages of items at once.

Function Details

getPagedAsyncIterator<TElement, TPage, TPageSettings, TLink>(PagedResult<TPage, TPageSettings, TLink>)

returns an async iterator that iterates over results. It also has a byPage method that returns pages of items at once.

function getPagedAsyncIterator<TElement, TPage, TPageSettings, TLink>(pagedResult: PagedResult<TPage, TPageSettings, TLink>): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>

Parameters

pagedResult

PagedResult<TPage, TPageSettings, TLink>

an object that specifies how to get pages.

Returns

PagedAsyncIterableIterator<TElement, TPage, TPageSettings>

a paged async iterator that iterates over results.