ApiCoreInterfaces
Interface: QueryRecord\<T, I, C\>
Defined in: packages/core/src/query/types.ts:161
A record a query found. Queries only return records this device can read,
so body is never null here.
Extends
Omit<NodeRecord<T>,"body">
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
I | AnyIncluded |
C | ComputedValues |
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
author | readonly | string | The key that signed this version, usually an app's session key, not the person: show root or createdBy as the author | Omit.author | packages/core/src/node/types.ts:272 |
body | readonly | T | Never null: a query leaves out records this node can't open | - | packages/core/src/query/types.ts:166 |
collection | readonly | string | - | Omit.collection | packages/core/src/node/types.ts:270 |
computed | readonly | C | Its collection's computed fields, derived from what this node holds (packages/core/docs/computed.md). Empty when the collection has none. | - | packages/core/src/query/types.ts:173 |
conforms | readonly | boolean | null | Whether the body fits its collection's schema; null when there is none or it can't be opened. A misfit still syncs. | Omit.conforms | packages/core/src/node/types.ts:294 |
createdAt | readonly | string | When it was created, by its creator's clock: for display only | Omit.createdAt | packages/core/src/node/types.ts:278 |
createdBy | readonly | string | null | The identity that created the record, when its first version is held | Omit.createdBy | packages/core/src/node/types.ts:276 |
deleted? | readonly | true | This version deletes the record (listed only with includeDeleted) | Omit.deleted | packages/core/src/node/types.ts:292 |
encrypted | readonly | boolean | - | Omit.encrypted | packages/core/src/node/types.ts:285 |
included | readonly | I | What each include found: records, or a number when it asked for a count. Empty without include. | - | packages/core/src/query/types.ts:168 |
issues? | readonly | readonly SchemaIssue[] | - | Omit.issues | packages/core/src/node/types.ts:295 |
key | readonly | string | The record's identity, the same across edits; links point here | Omit.key | packages/core/src/node/types.ts:264 |
links | readonly | readonly Link[] | What this record points at; empty when it can't be opened | Omit.links | packages/core/src/node/types.ts:284 |
reason? | readonly | string | - | Omit.reason | packages/core/src/node/types.ts:290 |
recordsOnly? | readonly | true | Signed under a note that grants writing records and no more: an app running records as code trusts only versions without it | Omit.recordsOnly | packages/core/src/node/types.ts:289 |
root | readonly | string | null | The identity that key was acting for, when its delegation checks out | Omit.root | packages/core/src/node/types.ts:274 |
seq | readonly | number | 0 for the first version, one more for each edit | Omit.seq | packages/core/src/node/types.ts:268 |
space | readonly | string | - | Omit.space | packages/core/src/node/types.ts:269 |
updatedAt | readonly | string | When this version was written: for display only | Omit.updatedAt | packages/core/src/node/types.ts:280 |
verified | readonly | boolean | Signature, delegation and shape all check out | Omit.verified | packages/core/src/node/types.ts:287 |
version | readonly | string | This version's id: a content hash | Omit.version | packages/core/src/node/types.ts:266 |