QueryOptions
QueryOptions<
TSelection,TOrder> =object
Defined in: src/actions/public/query.ts:14
Type Parameters
Section titled “Type Parameters”TSelection
Section titled “TSelection”TSelection extends SelectArg = SelectArg
TOrder
Section titled “TOrder”TOrder extends OrderTerm = OrderTerm
Properties
Section titled “Properties”count?
Section titled “count?”
optionalcount:boolean
Defined in: src/actions/public/query.ts:35
Whether to also count every entity the query matches, returned as count.
limit?
Section titled “limit?”
optionallimit:number
Defined in: src/actions/public/query.ts:26
Page size, up to the node maximum of 100.
offset?
Section titled “offset?”
optionaloffset:number
Defined in: src/actions/public/query.ts:33
How many matches to skip before the page. Defaults to none. Each request reads the latest
block, so writes between two requests shift the matches, and a row can repeat or be missed.
Sort by a key that does not change, such as asc("$key"), so that pages line up at least while
nothing is written.
orderBy?
Section titled “orderBy?”
optionalorderBy:TOrder&OrderCheck<TOrder,undefined>
Defined in: src/actions/public/query.ts:24
The sort, an asc(...) or a desc(...), sent as an ORDER BY clause after the query. There
is no schema here, so a key on a user attribute names its type, as in desc("score", "dec").
select?
Section titled “select?”
optionalselect:TSelection
Defined in: src/actions/public/query.ts:19
What to return — the same selection select() takes. Defaults to everything.