PagedResult interface

套件:

@azure/core-paging

描述如何與服務通訊的介面。

屬性

byPage	要在分頁非同步反覆運算器上實 byPage 作 方法的函式。 預設值為從 設定 maxPageSizeParam 的 settings.maxPageSize 。
firstPageLink	連結至結果的第一頁。
getPage	傳回結果頁面的方法。
toElements	從頁面擷取專案的函式。

屬性詳細資料

byPage

要在分頁非同步反覆運算器上實 byPage 作 方法的函式。 預設值為從 設定 maxPageSizeParam 的 settings.maxPageSize 。

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

屬性值

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

firstPageLink

連結至結果的第一頁。

firstPageLink: TLink

屬性值

TLink

getPage

傳回結果頁面的方法。

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

屬性值

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

toElements

從頁面擷取專案的函式。

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

屬性值

(page: TPage) => unknown[]