PagedResult interface

서비스와 통신하는 방법을 설명하는 인터페이스입니다.

속성

byPage

페이징된 비동기 반복기에서 메서드를 구현 byPage 하는 함수입니다. 기본값은 에서 settings.maxPageSizemaxPageSizeParam 설정하는 기본값입니다.

firstPageLink

결과의 첫 번째 페이지에 연결합니다.

getPage

결과 페이지를 반환하는 메서드입니다.

toElements

페이지에서 요소를 추출하는 함수입니다.

속성 세부 정보

byPage

페이징된 비동기 반복기에서 메서드를 구현 byPage 하는 함수입니다. 기본값은 에서 settings.maxPageSizemaxPageSizeParam 설정하는 기본값입니다.

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