Freigeben über


PagedResult interface

Eine Schnittstelle, die beschreibt, wie mit dem Dienst kommuniziert wird.

Eigenschaften

byPage

eine Funktion zum Implementieren der byPage Methode im ausgelagerten asynchronen Iterator. Der Standardwert ist eine, die von maxPageSizeParamsettings.maxPageSizefestlegt.

firstPageLink

Link zur ersten Seite der Ergebnisse.

getPage

Eine Methode, die eine Ergebnisseite zurückgibt.

toElements

Eine Funktion zum Extrahieren von Elementen aus einer Seite.

Details zur Eigenschaft

byPage

eine Funktion zum Implementieren der byPage Methode im ausgelagerten asynchronen Iterator. Der Standardwert ist eine, die von maxPageSizeParamsettings.maxPageSizefestlegt.

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

Eigenschaftswert

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

Link zur ersten Seite der Ergebnisse.

firstPageLink: TLink

Eigenschaftswert

TLink

getPage

Eine Methode, die eine Ergebnisseite zurückgibt.

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

Eigenschaftswert

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

toElements

Eine Funktion zum Extrahieren von Elementen aus einer Seite.

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

Eigenschaftswert

(page: TPage) => unknown[]