PagedResult interface
サービスと通信する方法を説明するインターフェイス。
プロパティ
| by |
ページングされた非同期反復子に |
| first |
結果の最初のページにリンクします。 |
| get |
結果のページを返すメソッド。 |
| to |
ページから要素を抽出する関数。 |
プロパティの詳細
byPage
ページングされた非同期反復子に byPage メソッドを実装する関数。 既定値は、 から settings.maxPageSizeを設定しますmaxPageSizeParam。
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[]