Class SeamPaginator<TResponse, TResponseKey>

Type Parameters

const TResponse
const TResponseKey extends keyof TResponse

Implements

AsyncIterable<EnsureReadonlyArray<TResponse[TResponseKey]>>

Index

Constructors

Methods

[asyncIterator] firstPage flatten flattenToArray nextPage

Constructors

constructor

new SeamPaginator<
    const TResponse,
    const TResponseKey extends string | number | symbol,
>(
    parent: SeamPaginatorParent,
    request: SeamHttpRequest<TResponse, TResponseKey>,
): SeamPaginator<TResponse, TResponseKey>
Type Parameters
- const TResponse
- const TResponseKey extends string | number | symbol
Parameters
- parent: SeamPaginatorParent
- request: SeamHttpRequest<TResponse, TResponseKey>
Returns SeamPaginator<TResponse, TResponseKey>
- Defined in src/lib/seam/connect/seam-paginator.ts:28

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<
EnsureReadonlyArray<TResponse[TResponseKey]>,
>
Returns AsyncGenerator<EnsureReadonlyArray<TResponse[TResponseKey]>>
Implementation of AsyncIterable.[asyncIterator]
- Defined in src/lib/seam/connect/seam-paginator.ts:136

firstPage

firstPage(): Promise<[EnsureReadonlyArray<TResponse[TResponseKey]>, Pagination]>
Returns Promise<[EnsureReadonlyArray<TResponse[TResponseKey]>, Pagination]>
- Defined in src/lib/seam/connect/seam-paginator.ts:41

flatten

flatten(): AsyncGenerator<EnsureReadonlyArray<TResponse[TResponseKey]>>
Returns AsyncGenerator<EnsureReadonlyArray<TResponse[TResponseKey]>>
- Defined in src/lib/seam/connect/seam-paginator.ts:121

flattenToArray

flattenToArray(): Promise<EnsureReadonlyArray<TResponse[TResponseKey]>>
Returns Promise<EnsureReadonlyArray<TResponse[TResponseKey]>>
- Defined in src/lib/seam/connect/seam-paginator.ts:108

nextPage

nextPage(
nextPageCursor: null | SeamPageCursor,
): Promise<[EnsureReadonlyArray<TResponse[TResponseKey]>, Pagination]>
Parameters
- nextPageCursor: null | SeamPageCursor
Returns Promise<[EnsureReadonlyArray<TResponse[TResponseKey]>, Pagination]>
- Defined in src/lib/seam/connect/seam-paginator.ts:47