Поделиться через


PagedResult interface

Интерфейс, описывающий способ взаимодействия со службой.

Свойства

byPage

Функция для реализации byPage метода в асинхронном итераторе с выстраивным. Значением по умолчанию является тот, который задает из maxPageSizeParamsettings.maxPageSize.

firstPageLink

Ссылка на первую страницу результатов.

getPage

Метод, возвращающий страницу результатов.

toElements

Функция для извлечения элементов из страницы.

Сведения о свойстве

byPage

Функция для реализации byPage метода в асинхронном итераторе с выстраивным. Значением по умолчанию является тот, который задает из maxPageSizeParamsettings.maxPageSize.

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

Значение свойства

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

Ссылка на первую страницу результатов.

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