Class ObjNode<Value>

Represents a obj JSON CRDT node, which is a Last-write-wins (LWW) object. It is a map of string keys to LWW registers. The value of each register is a reference to another JSON CRDT node.

Type Parameters

Value extends Record<string, JsonNode> = Record<string, JsonNode>

Implements

JsonNode<JsonNodeView<Value>>
Printable

Index

Constructors

Properties

Methods

get name nodes toString

Constructors

constructor

new ObjNode<Value>(id): ObjNode<Value>
Type Parameters
- Value extends Record<string, JsonNode<unknown>> = Record<string, JsonNode<unknown>>
Parameters
- id: ITimestampStruct
Returns ObjNode<Value>
- Defined in src/json-crdt/nodes/obj/ObjNode.ts:23

Properties

`Readonly` id

id: ITimestampStruct

Unique ID within a document.

Methods

get

get<K>(key): undefined | Value[K]
Retrieves a JSON CRDT node at the given key.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  A key of the object.
Returns undefined | Value[K]
JSON CRDT node at the given key, if any.
- Defined in src/json-crdt/nodes/obj/ObjNode.ts:37

name

name(): string
Returns the name of the JSON node type.

Returns string
Implementation of JsonNode.name
- Defined in src/json-crdt/nodes/obj/ObjNode.ts:133

nodes

nodes(callback): void
Iterate over all key-value pairs in the object.
Parameters
- callback: ((node, key) => void)
  Callback to call for each key-value pair.
  - - (node, key): void
    - Parameters
      node: JsonNode<unknown>
      key: string
      Returns void
Returns void
- Defined in src/json-crdt/nodes/obj/ObjNode.ts:63

toString

toString(tab?): string
Parameters
- tab: string = ''
Returns string
Implementation of JsonNode.toString
- Defined in src/json-crdt/nodes/obj/ObjNode.ts:139