Skip to main content

Class: PaginatedIterator<T>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:92

Async iterator for paginated API responses

Type Parameters​

T​

T

Implements​

  • AsyncIterable<T>

Constructors​

Constructor​

new PaginatedIterator<T>(fetcher, options?): PaginatedIterator<T>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:102

Parameters​

fetcher​

PageFetcher<T>

options?​

AutoPaginateOptions = {}

Returns​

PaginatedIterator<T>

Methods​

[asyncIterator]()​

[asyncIterator](): AsyncIterator<T>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:115

Get async iterator

Returns​

AsyncIterator<T>

Implementation of​

AsyncIterable.[asyncIterator]

count()​

count(): Promise<number>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:329

Count total items

Returns​

Promise<number>

every()​

every(predicate): Promise<boolean>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:306

Check if all items match predicate

Parameters​

predicate​

(item, index) => boolean | Promise<boolean>

Returns​

Promise<boolean>

filter()​

filter(predicate): Promise<T[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:221

Filter items

Parameters​

predicate​

(item, index) => boolean | Promise<boolean>

Returns​

Promise<T[]>

find()​

find(predicate): Promise<T>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:235

Find first matching item

Parameters​

predicate​

(item, index) => boolean | Promise<boolean>

Returns​

Promise<T>

first()​

first(): Promise<T>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:350

Get first item

Returns​

Promise<T>

forEach()​

forEach(callback): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:319

Execute callback for each item

Parameters​

callback​

(item, index) => void | Promise<void>

Returns​

Promise<void>

getMeta()​

getMeta(): PaginationMeta

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:185

Get pagination metadata

Returns​

PaginationMeta

isEmpty()​

isEmpty(): Promise<boolean>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:340

Check if iterator is empty

Returns​

Promise<boolean>

last()​

last(): Promise<T>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:360

Get last item (requires iterating all items)

Returns​

Promise<T>

map()​

map<U>(fn): Promise<U[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:209

Map over all items

Type Parameters​

U​

U

Parameters​

fn​

(item, index) => U | Promise<U>

Returns​

Promise<U[]>

reduce()​

reduce<U>(fn, initialValue): Promise<U>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:278

Reduce over all items

Type Parameters​

U​

U

Parameters​

fn​

(accumulator, item, index) => U | Promise<U>

initialValue​

U

Returns​

Promise<U>

skip()​

skip(count): AsyncIterableIterator<T>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:264

Skip first N items

Parameters​

count​

number

Returns​

AsyncIterableIterator<T>

some()​

some(predicate): Promise<boolean>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:293

Check if any item matches predicate

Parameters​

predicate​

(item, index) => boolean | Promise<boolean>

Returns​

Promise<boolean>

take()​

take(count): Promise<T[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:250

Take first N items

Parameters​

count​

number

Returns​

Promise<T[]>

toArray()​

toArray(): Promise<T[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/pagination.ts:198

Collect all items into an array

Returns​

Promise<T[]>