Compartilhar via

PagedResult interface

  • Referência
Pacote:
@azure/core-paging

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

Propriedades

byPage

uma função para implementar o byPage método no iterador assíncrono paginado. O padrão é aquele que define o maxPageSizeParam 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 da propriedade

byPage

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

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

Valor da propriedade

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

Link para a primeira página de resultados.

firstPageLink: TLink

Valor da 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 da 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 da propriedade

(page: TPage) => unknown[]