PagedResult interface

Pacote:

@azure/core-paging

Uma interface que descreve como se comunicar com o serviço.

Propriedades

byPage	Uma função para implementar o método byPage no iterador assíncrono paginado. O padrão é aquele que define o maxPageSizeParam a partir de settings.maxPageSize.
firstPageLink	Link para a primeira página de resultados.
getPage	Um método que retorna uma página de resultados.
toElements	Uma função para extrair elementos de uma página.

Detalhes de Propriedade

byPage

Uma função para implementar o método byPage no iterador assíncrono paginado. O padrão é aquele que define o maxPageSizeParam a partir de settings.maxPageSize.

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

Valor de Propriedade

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

firstPageLink

Link para a primeira página de resultados.

firstPageLink: TLink

Valor de Propriedade

TLink

getPage

Um método que retorna uma página de resultados.

getPage: (pageLink: TLink, maxPageSize?: number) => Promise<undefined | { nextPageLink?: TLink, page: TPage }>

Valor de Propriedade

(pageLink: TLink, maxPageSize?: number) => Promise<undefined | { nextPageLink?: TLink, page: TPage }>

toElements

Uma função para extrair elementos de uma página.

toElements?: (page: TPage) => unknown[]

Valor de Propriedade

(page: TPage) => unknown[]