PagedResult interface

Pakiet:

@azure/core-paging

Interfejs opisujący sposób komunikowania się z usługą.

Właściwości

byPage	funkcja implementowania byPage metody na iteratorze asynchronizowanym. Wartość domyślna to ta, która ustawia element z maxPageSizeParamsettings.maxPageSize.
firstPageLink	Łącze do pierwszej strony wyników.
getPage	Metoda zwracająca stronę wyników.
toElements	Funkcja wyodrębniania elementów ze strony.

Szczegóły właściwości

byPage

funkcja implementowania byPage metody na iteratorze asynchronizowanym. Wartość domyślna to ta, która ustawia element z maxPageSizeParamsettings.maxPageSize.

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

Wartość właściwości

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

firstPageLink

Łącze do pierwszej strony wyników.

firstPageLink: TLink

Wartość właściwości

TLink

getPage

Metoda zwracająca stronę wyników.

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

Wartość właściwości

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

toElements

Funkcja wyodrębniania elementów ze strony.

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

Wartość właściwości

(page: TPage) => unknown[]