Skip to content

PageOptions

Defined in: packages/core/src/api.ts:35

How a list is paged. Each route has its own defaults; set only what you need to change.

Item = unknown

optional cursor?: "before" | "after"

Defined in: packages/core/src/api.ts:42

Which end the next page starts from: after the last id, or before it.


optional idOf?: (item) => string

Defined in: packages/core/src/api.ts:48

How to read an item’s id, when it is not id or user.id.

Item

string


optional limit?: number

Defined in: packages/core/src/api.ts:40

Items per request.


optional query?: Record<string, string | number | boolean | undefined>

Defined in: packages/core/src/api.ts:46

Other query parameters sent with every page.


optional signal?: AbortSignal

Defined in: packages/core/src/api.ts:29

Cancels the request, and any wait for a rate limit.

RouteOptions.signal


optional start?: string

Defined in: packages/core/src/api.ts:44

Where to start: an id.