Skip to main content

Interface: CursorPaginationOptions<T>

Defined in: src/query/CursorPagination.ts:3

Type Parameters​

Type Parameter
T

Properties​

cursor?​

optional cursor?: string | Record<string, any>

Defined in: src/query/CursorPagination.ts:7

The cursor token (base64 string) or plain object representing the cursor position.

limit​

limit: number

Defined in: src/query/CursorPagination.ts:12

Maximum number of items to return.

orderBy​

orderBy: ColumnKey<T> | ((entity) => unknown)

Defined in: src/query/CursorPagination.ts:17

Column or selector function to order by.

direction?​

optional direction?: "desc" | "asc"

Defined in: src/query/CursorPagination.ts:22

Sort direction: 'asc' or 'desc'. Defaults to 'asc'.

tieBreaker?​

optional tieBreaker?: ColumnKey<T> | ((entity) => unknown)

Defined in: src/query/CursorPagination.ts:27

Tie-breaker column name or selector function. Defaults to 'id'.