PagedResult interface

Balíček:

@azure/core-paging

Rozhraní, které popisuje, jak komunikovat se službou.

Vlastnosti

byPage	funkce pro implementaci byPage metody na stránkovaném asynchronním iterátoru. Výchozí hodnota je ta, která nastaví hodnotu maxPageSizeParam z settings.maxPageSize.
firstPageLink	Odkaz na první stránku výsledků
getPage	Metoda, která vrací stránku výsledků.
toElements	Funkce pro extrakci prvků ze stránky.

Podrobnosti vlastnosti

byPage

funkce pro implementaci byPage metody na stránkovaném asynchronním iterátoru. Výchozí hodnota je ta, která nastaví hodnotu maxPageSizeParam z settings.maxPageSize.

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

Hodnota vlastnosti

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

firstPageLink

Odkaz na první stránku výsledků

firstPageLink: TLink

Hodnota vlastnosti

TLink

getPage

Metoda, která vrací stránku výsledků.

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

Hodnota vlastnosti

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

toElements

Funkce pro extrakci prvků ze stránky.

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

Hodnota vlastnosti

(page: TPage) => unknown[]