ApiCoreInterfaces
Interface: NodeRecord\<T\>
Defined in: packages/core/src/node/types.ts:262
A record, opened and checked: its current version, unless listed as history
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Properties
| Property | Modifier | Type | Description | 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 | packages/core/src/node/types.ts:272 |
body | readonly | T | null | The content, or null when it is encrypted and this node has no key | packages/core/src/node/types.ts:282 |
collection | readonly | string | - | packages/core/src/node/types.ts:270 |
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. | packages/core/src/node/types.ts:294 |
createdAt | readonly | string | When it was created, by its creator's clock: for display only | packages/core/src/node/types.ts:278 |
createdBy | readonly | string | null | The identity that created the record, when its first version is held | packages/core/src/node/types.ts:276 |
deleted? | readonly | true | This version deletes the record (listed only with includeDeleted) | packages/core/src/node/types.ts:292 |
encrypted | readonly | boolean | - | packages/core/src/node/types.ts:285 |
issues? | readonly | readonly SchemaIssue[] | - | packages/core/src/node/types.ts:295 |
key | readonly | string | The record's identity, the same across edits; links point here | packages/core/src/node/types.ts:264 |
links | readonly | readonly Link[] | What this record points at; empty when it can't be opened | packages/core/src/node/types.ts:284 |
reason? | readonly | string | - | 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 | packages/core/src/node/types.ts:289 |
root | readonly | string | null | The identity that key was acting for, when its delegation checks out | packages/core/src/node/types.ts:274 |
seq | readonly | number | 0 for the first version, one more for each edit | packages/core/src/node/types.ts:268 |
space | readonly | string | - | packages/core/src/node/types.ts:269 |
updatedAt | readonly | string | When this version was written: for display only | packages/core/src/node/types.ts:280 |
verified | readonly | boolean | Signature, delegation and shape all check out | packages/core/src/node/types.ts:287 |
version | readonly | string | This version's id: a content hash | packages/core/src/node/types.ts:266 |