Interface: NodeRecords

Defined in: packages/core/src/node/types.ts:570

MethodsCopy Anchor Link

addFile()Copy Anchor Link

addFile(
   spaceId, 
   bytes, 
   about
): Promise<FileRef>;

Defined in: packages/core/src/node/types.ts:626

Seals and keeps a file, giving the reference to put in a body (spec 05 §16.6)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<FileRef>

can()Copy Anchor Link

can(
   spaceId, 
   action, 
   target
): Promise<boolean>;

Defined in: packages/core/src/node/types.ts:624

Whether this account may create in a collection, or edit / delete a record; target names it

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

contracts()Copy Anchor Link

contracts(
   spaceId, 
   key, 
   version?
): Promise<RecordContracts | null>;

Defined in: packages/core/src/node/types.ts:582

How a record's newest standing version, or the one named, fares under its collection's contract: { version, passes, reason?, pending?, unjudged? }. passes is false with the failing condition's else as reason, and null when the collection has no contract, the version waits on one it cites (pending), or this library can't judge it (unjudged, with why)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<RecordContracts | null>

delete()Copy Anchor Link

delete(spaceId, key): Promise<void>;

Defined in: packages/core/src/node/types.ts:620

Deletes a record everywhere, by writing a version marked deleted

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

get()Copy Anchor Link

get<T>(spaceId, key): Promise<NodeRecord<T> | null>;

Defined in: packages/core/src/node/types.ts:574

A record's current version, or null when there is none or it was deleted

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<NodeRecord<T> | null>

history()Copy Anchor Link

history<T>(spaceId, key): Promise<readonly NodeRecord<T>[]>;

Defined in: packages/core/src/node/types.ts:622

The versions of a record kept whole here, newest first: the current one, or every one in a collection defined with history: 'all'

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly NodeRecord<T>[]>

keyFor()Copy Anchor Link

keyFor(
   spaceId, 
   name, 
   account?
): Promise<string>;

Defined in: packages/core/src/node/types.ts:584

The key name has in an account's namespace (this one's by default): where put(…, { key: name }) writes

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<string>

linked()Copy Anchor Link

linked<T>(
   spaceId, 
   key, 
   options?
): Promise<readonly NodeRecord<T>[]>;

Defined in: packages/core/src/node/types.ts:614

The records whose current version points at this one, optionally by role or collection

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly NodeRecord<T>[]>

list()Copy Anchor Link

list<T>(spaceId, options?): Promise<readonly NodeRecord<T>[]>;

Defined in: packages/core/src/node/types.ts:572

Current versions, oldest record first; deleted records only with includeDeleted

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly NodeRecord<T>[]>

onePerKey()Copy Anchor Link

onePerKey(
   spaceId, 
   collection, 
   body, 
   options?
): Promise<string | null>;

Defined in: packages/core/src/node/types.ts:586

The key a record with this body has under its collection's onePer; null when there is none

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<string | null>

put()Copy Anchor Link

Call SignatureCopy Anchor Link

put<T>(
   spaceId, 
   collection, 
   body, 
   options?
): Promise<NodeRecord<T>>;

Defined in: packages/core/src/node/types.ts:593

Creates a record under a fresh key, or key in this account's namespace. Writing a deleted key brings it back.

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<NodeRecord<T>>

Call SignatureCopy Anchor Link

put<C>(
   spaceId, 
   collection, 
   body, 
   options?
): Promise<NodeRecord<BodyOf<C>>>;

Defined in: packages/core/src/node/types.ts:600

The same, typed by the collection's definition

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<NodeRecord<BodyOf<C>>>

query()Copy Anchor Link

query<C, I>(spaceId, query): Promise<ResultFor<C, I>>;

Defined in: packages/core/src/node/types.ts:637

Records matching a query, typed when it names a collection by its definition.

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<ResultFor<C, I>>

ThrowsCopy Anchor Link

When the query is malformed, saying what to fix

readFile()Copy Anchor Link

readFile(spaceId, ref): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: packages/core/src/node/types.ts:632

The bytes of a file a body refers to: held here, or fetched from peers or mirrors, checking every chunk. While nobody has it, it waits and asks again.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<Uint8Array<ArrayBufferLike>>

ThrowsCopy Anchor Link

When no record here names it, when it won't open as named, or when the space closes

update()Copy Anchor Link

update<T>(
   spaceId, 
   key, 
   body, 
   options?
): Promise<NodeRecord<T>>;

Defined in: packages/core/src/node/types.ts:607

Writes the record's next version; links carry over unless given

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<NodeRecord<T>>

watch()Copy Anchor Link

watch<C, I>(
   spaceId, 
   query, 
   onResult, 
   onError?
): () => void;

Defined in: packages/core/src/node/types.ts:642

Runs a query now and whenever the space's records change; returns a function that stops it

Type ParametersCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

() => void