PagedResult interface

Paquete:

@azure/core-paging

Interfaz que describe cómo comunicarse con el servicio.

Propiedades

byPage	una función para implementar el método byPage en el iterador asincrónico paginado. El valor predeterminado es aquel que establece el maxPageSizeParam de settings.maxPageSize.
firstPageLink	Vínculo a la primera página de resultados.
getPage	Método que devuelve una página de resultados.
toElements	Función para extraer elementos de una página.

Detalles de las propiedades

byPage

una función para implementar el método byPage en el iterador asincrónico paginado. El valor predeterminado es aquel que establece el maxPageSizeParam de settings.maxPageSize.

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

Valor de propiedad

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

firstPageLink

Vínculo a la primera página de resultados.

firstPageLink: TLink

Valor de propiedad

TLink

getPage

Método que devuelve una página de resultados.

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

Valor de propiedad

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

toElements

Función para extraer elementos de una página.

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

Valor de propiedad

(page: TPage) => unknown[]