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[]