ApiCoreInterfaces
Interface: Query\<C, I\>
Defined in: packages/core/src/query/types.ts:139
A query. With a typed collection (a definition made with collection(),
or a Typed name), where and sort are typed from it: its body's
fields, its link roles and its computed fields, each with its value's type.
Type Parameters
| Type Parameter | Default type |
|---|---|
C extends CollectionRef | CollectionRef |
I extends IncludeMap | undefined | IncludeMap | undefined |
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
collection | readonly | C | By name, or a reference that carries its records' type (see CollectionRef) | packages/core/src/query/types.ts:144 |
cursor? | readonly | string | From the previous page's cursor | packages/core/src/query/types.ts:151 |
include? | readonly | I | - | packages/core/src/query/types.ts:146 |
limit? | readonly | number | - | packages/core/src/query/types.ts:149 |
sort? | readonly | SortOf<C> | Fields to sort by, in order: { done: 'asc', '@createdAt': 'desc' }. Ties always break on the key. | packages/core/src/query/types.ts:148 |
where? | readonly | FilterOf<C> | - | packages/core/src/query/types.ts:145 |