Class RootNode<Value>

The root of a JSON CRDT document. RootNode is a ValNode with a special 0.0 ID, which is always the same. It is used to represent the root of a document.

Type Parameters

Value extends JsonNode = JsonNode

Hierarchy (View Summary)

ValNode<Value>
- RootNode

Index

Constructors

constructor

new RootNode<Value extends JsonNode<unknown> = JsonNode<unknown>>(
doc: Model<any>,
val: ITimestampStruct,
): RootNode<Value>
Type Parameters
- Value extends JsonNode<unknown> = JsonNode<unknown>
Parameters
- doc: Model<any>
- val: ITimestampStruct
  Latest value of the document root.
Returns RootNode<Value>
Overrides ValNode.constructor
- Defined in src/json-crdt/nodes/root/RootNode.ts:18

Properties

`Readonly`id

id: ITimestampStruct

Unique ID within a document.

val

val: ITimestampStruct

The current value of the node, which is a reference to another JSON CRDT node.

Methods

name

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

Returns string
Overrides ValNode.name
- Defined in src/json-crdt/nodes/root/RootNode.ts:22

node

node(): Value
Returns the latest value of the node, the JSON CRDT node that val points to.

Returns Value
The latest value of the node.
Inherited from ValNode.node
- Defined in src/json-crdt/nodes/val/ValNode.ts:47

toString

toString(tab?: string): string
Parameters
- tab: string = ''
Returns string
Inherited from ValNode.toString
- Defined in src/json-crdt/nodes/val/ValNode.ts:90

view

view(): JsonNodeView<Value>
Returns a POJO object which represents the "view" of this JSON node model.

Returns JsonNodeView<Value>
Inherited from ValNode.view
- Defined in src/json-crdt/nodes/val/ValNode.ts:53

Class RootNode<Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RootNode<Value>

Properties

`Readonly`id

val

Methods

name

Returns string

node

Returns Value

toString

Parameters

Returns string

view

Returns JsonNodeView<Value>

Settings

On This Page

Class RootNode<Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RootNode<Value>

Properties

Readonlyid

val

Methods

name

Returns string

node

Returns Value

toString

Parameters

Returns string

view

Returns JsonNodeView<Value>

Settings

On This Page

`Readonly`id