PagedResult interface
描述如何与服务通信的接口。
属性
| by |
用于在分页异步迭代器上实现 |
| first |
链接到结果的第一页。 |
| get |
返回结果页的方法。 |
| to |
用于从页面中提取元素的函数。 |
属性详细信息
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[]