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