PagedResult interface

Paket:

@azure/core-paging

Ett gränssnitt som beskriver hur du kommunicerar med tjänsten.

Egenskaper

byPage	en funktion för att implementera metoden byPage i den sidiga asynkrona iteratorn. Standardvärdet är ett som anger maxPageSizeParam från settings.maxPageSize.
firstPageLink	Länka till den första sidan med resultat.
getPage	En metod som returnerar en resultatsida.
toElements	En funktion för att extrahera element från en sida.

Egenskapsinformation

byPage

en funktion för att implementera metoden byPage i den sidiga asynkrona iteratorn. Standardvärdet är ett som anger maxPageSizeParam från settings.maxPageSize.

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

Egenskapsvärde

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

firstPageLink

Länka till den första sidan med resultat.

firstPageLink: TLink

Egenskapsvärde

TLink

getPage

En metod som returnerar en resultatsida.

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

Egenskapsvärde

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

toElements

En funktion för att extrahera element från en sida.

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

Egenskapsvärde

(page: TPage) => unknown[]