PagedResult interface

Paquet:

@azure/core-paging

Interface qui décrit comment communiquer avec le service.

Propriétés

byPage	fonction permettant d’implémenter la méthode byPage sur l’itérateur asynchrone paginé. La valeur par défaut est celle qui définit la maxPageSizeParam à partir de settings.maxPageSize.
firstPageLink	Lien vers la première page des résultats.
getPage	Méthode qui retourne une page de résultats.
toElements	Fonction permettant d’extraire des éléments d’une page.

Détails de la propriété

byPage

fonction permettant d’implémenter la méthode byPage sur l’itérateur asynchrone paginé. La valeur par défaut est celle qui définit la maxPageSizeParam à partir de settings.maxPageSize.

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

Valeur de propriété

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

firstPageLink

Lien vers la première page des résultats.

firstPageLink: TLink

Valeur de propriété

TLink

getPage

Méthode qui retourne une page de résultats.

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

Valeur de propriété

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

toElements

Fonction permettant d’extraire des éléments d’une page.

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

Valeur de propriété

(page: TPage) => unknown[]