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.
Extends
Section titled “Extends”Pick<RouteOptions,"signal">
Type Parameters
Section titled “Type Parameters”Item = unknown
Properties
Section titled “Properties”cursor?
Section titled “cursor?”
optionalcursor?:"before"|"after"
Defined in: packages/core/src/api.ts:42
Which end the next page starts from: after the last id, or before it.
optionalidOf?: (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.
Parameters
Section titled “Parameters”Item
Returns
Section titled “Returns”string
limit?
Section titled “limit?”
optionallimit?:number
Defined in: packages/core/src/api.ts:40
Items per request.
query?
Section titled “query?”
optionalquery?:Record<string,string|number|boolean|undefined>
Defined in: packages/core/src/api.ts:46
Other query parameters sent with every page.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/core/src/api.ts:29
Cancels the request, and any wait for a rate limit.
Inherited from
Section titled “Inherited from”start?
Section titled “start?”
optionalstart?:string
Defined in: packages/core/src/api.ts:44
Where to start: an id.