PagedResult interface

Pakiet:

@azure/core-paging

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

Właściwości

byPage	funkcja implementowania metody byPage na stronie iteratora asynchronicznego. Wartość domyślna to ta, która ustawia maxPageSizeParam z settings.maxPageSize.
firstPageLink	Połącz z pierwszą stroną 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 metody byPage na stronie iteratora asynchronicznego. Wartość domyślna to ta, która ustawia maxPageSizeParam z settings.maxPageSize.

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

Wartość właściwości

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

firstPageLink

Połącz z pierwszą stroną 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[]