Skip to main content

Interface: AutoPaginateOptions

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

Options for auto-pagination

Extends​

Properties​

cursor?​

optional cursor?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:407

Cursor for cursor-based pagination

Inherited from​

PaginationOptions.cursor

delayBetweenPages?​

optional delayBetweenPages?: number

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

Delay between page requests in ms (default: 0)

limit?​

optional limit?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:402

Items per page

Default​

20

Inherited from​

PaginationOptions.limit

maxItems?​

optional maxItems?: number

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

Maximum items to fetch (default: unlimited)

maxPages?​

optional maxPages?: number

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

Maximum pages to fetch (default: unlimited)

onError?​

optional onError?: (error, page) => "retry" | "skip" | "abort"

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

Callback for errors

Parameters​

error​

Error

page​

number

Returns​

"retry" | "skip" | "abort"

onPage?​

optional onPage?: (page, items, total) => void

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

Callback for each page

Parameters​

page​

number

items​

number

total​

number

Returns​

void

page?​

optional page?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:396

Page number (1-based)

Default​

1

Inherited from​

PaginationOptions.page

sortBy?​

optional sortBy?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:412

Sort field

Inherited from​

PaginationOptions.sortBy

sortOrder?​

optional sortOrder?: "asc" | "desc"

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:418

Sort order

Default​

'desc'

Inherited from​

PaginationOptions.sortOrder