Class ArrNode<Element>

Represents the arr JSON CRDT type, which is a Replicated Growable Array (RGA). Each element ot the array is a reference to another JSON CRDT node.

Type Parameters

Element extends JsonNode = JsonNode

Hierarchy

AbstractRga<E[]>
- ArrNode

Implements

JsonNode<JsonNodeView<Element>[]>
Printable

Constructors

constructor

new ArrNode<Element extends JsonNode<unknown> = JsonNode<unknown>>(
doc: Model<any>,
id: ITimestampStruct,
): ArrNode<Element>
Type Parameters
- Element extends JsonNode<unknown> = JsonNode<unknown>
Parameters
- doc: Model<any>
- id: ITimestampStruct
Returns ArrNode<Element>
Overrides AbstractRga<E[]>.constructor
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:82

Properties

count

count: number = 0

`Readonly`doc

doc: Model<any>

`Readonly`id

id: ITimestampStruct

Unique ID within a document.

ids

ids: undefined | Chunk<ITimestampStruct[]> = undefined

root

root: undefined | Chunk<ITimestampStruct[]> = undefined

Methods

delete

delete(spans: ITimespanStruct[]): void
Parameters
- spans: ITimespanStruct[]
Returns void
Inherited from AbstractRga.delete
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:233

deleteChunk

deleteChunk(chunk: Chunk<ITimestampStruct[]>): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.deleteChunk
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:700

`Protected`deleteId

deleteId(chunk: Chunk<ITimestampStruct[]>): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.deleteId
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:753

`Protected`deleteSpan

deleteSpan(span: ITimespanStruct): void
Parameters
- span: ITimespanStruct
Returns void
Inherited from AbstractRga.deleteSpan
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:239

find

find(position: number): undefined | ITimestampStruct
Parameters
- position: number
Returns undefined | ITimestampStruct
Inherited from AbstractRga.find
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:298

findById

findById(after: ITimestampStruct): undefined | Chunk<ITimestampStruct[]>
Parameters
- after: ITimestampStruct
Returns undefined | Chunk<ITimestampStruct[]>
Inherited from AbstractRga.findById
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:758

findChunk

findChunk(
position: number,
): undefined | [chunk: Chunk<ITimestampStruct[]>, offset: number]
Parameters
- position: number
Returns undefined | [chunk: Chunk<ITimestampStruct[]>, offset: number]
Inherited from AbstractRga.findChunk
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:320

findInterval

findInterval(position: number, length: number): ITimespanStruct[]
Parameters
- position: number
- length: number
Returns ITimespanStruct[]
Inherited from AbstractRga.findInterval
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:340

findInterval2

findInterval2(from: ITimestampStruct, to: ITimestampStruct): ITimespanStruct[]
Rename to .rangeX() method?
Parameters
- from: ITimestampStruct
- to: ITimestampStruct
Returns ITimespanStruct[]
Inherited from AbstractRga.findInterval2
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:386

first

first(): undefined | Chunk<ITimestampStruct[]>
Returns undefined | Chunk<ITimestampStruct[]>
Inherited from AbstractRga.first
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:446

`Protected`formatChunk

formatChunk(chunk: Chunk<ITimestampStruct[]>): string
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns string
Inherited from AbstractRga.formatChunk
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:958

get

get(position: number): undefined | ITimestampStruct
Returns a reference to an element at a given position in the array.
Parameters
- position: number
  The position of the element to get.
Returns undefined | ITimestampStruct
An element of the array, if any.
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:95

getById

getById(id: ITimestampStruct): undefined | ITimestampStruct
Parameters
- id: ITimestampStruct
Returns undefined | ITimestampStruct
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:131

getId

getId(position: number): undefined | ITimestampStruct
Returns ID of the RGA slot (not the referenced JSON node) at a given position in the array. The ID is a timestamp the unique slot of the element in the RGA. To retrieve the JSON node ID referenced by the slot, use get method.
Parameters
- position: number
  The position of the element to get.
Returns undefined | ITimestampStruct
ID of the RGA slot.

Todo
Rename to getRef.
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:123

getNode

getNode(position: number): undefined | JsonNode<unknown>
Returns a JSON node at a given position in the array.
Parameters
- position: number
  The position of the element to get.
Returns undefined | JsonNode<unknown>
A JSON node, if any.
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:107

ingest

ingest(size: number, next: () => Chunk<ITimestampStruct[]>): void
Parameters
- size: number
- next: () => Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.ingest
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:894

ins

ins(
    after: ITimestampStruct,
    id: ITimestampStruct,
    content: ITimestampStruct[],
): void
Parameters
- after: ITimestampStruct
- id: ITimestampStruct
- content: ITimestampStruct[]
Returns void
Inherited from AbstractRga.ins
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:135

`Protected`insAfterChunk

insAfterChunk(
    after: ITimestampStruct,
    chunk: Chunk<ITimestampStruct[]>,
    chunkOffset: number,
    id: ITimestampStruct,
    content: ITimestampStruct[],
): void
Parameters
- after: ITimestampStruct
- chunk: Chunk<ITimestampStruct[]>
- chunkOffset: number
- id: ITimestampStruct
- content: ITimestampStruct[]
Returns void
Inherited from AbstractRga.insAfterChunk
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:206

`Protected`insAfterRoot

insAfterRoot(
    after: ITimestampStruct,
    id: ITimestampStruct,
    content: ITimestampStruct[],
): void
Parameters
- after: ITimestampStruct
- id: ITimestampStruct
- content: ITimestampStruct[]
Returns void
Inherited from AbstractRga.insAfterRoot
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:195

insAt

insAt(
    position: number,
    id: ITimestampStruct,
    content: ITimestampStruct[],
): undefined | ITimestampStruct
Parameters
- position: number
- id: ITimestampStruct
- content: ITimestampStruct[]
Returns undefined | ITimestampStruct
Inherited from AbstractRga.insAt
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:180

insertAfter

insertAfter(
chunk: Chunk<ITimestampStruct[]>,
after: Chunk<ITimestampStruct[]>,
): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
- after: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.insertAfter
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:533

`Protected`insertAfterRef

insertAfterRef(
    chunk: Chunk<ITimestampStruct[]>,
    ref: ITimestampStruct,
    left: Chunk<ITimestampStruct[]>,
): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
- ref: ITimestampStruct
- left: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.insertAfterRef
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:549

insertBefore

insertBefore(
chunk: Chunk<ITimestampStruct[]>,
before: Chunk<ITimestampStruct[]>,
): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
- before: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.insertBefore
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:517

insertId

insertId(chunk: Chunk<ITimestampStruct[]>): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.insertId
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:742

insertIdFast

insertIdFast(chunk: Chunk<ITimestampStruct[]>): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.insertIdFast
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:748

`Protected`insertInside

insertInside(
    chunk: Chunk<ITimestampStruct[]>,
    at: Chunk<ITimestampStruct[]>,
    offset: number,
): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
- at: Chunk<ITimestampStruct[]>
- offset: number
Returns void
Inherited from AbstractRga.insertInside
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:587

iterator

iterator(): () => undefined | Chunk<ITimestampStruct[]>
Returns () => undefined | Chunk<ITimestampStruct[]>
Inherited from AbstractRga.iterator
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:885

last

last(): undefined | Chunk<ITimestampStruct[]>
Returns undefined | Chunk<ITimestampStruct[]>
Inherited from AbstractRga.last
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:456

lastId

lastId(): undefined | ITimestampStruct
Returns undefined | ITimestampStruct
Inherited from AbstractRga.lastId
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:466

length

length(): number
Content length.

Returns number
Inherited from AbstractRga.length
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:487

`Protected`mergeContent

mergeContent(
chunk: Chunk<ITimestampStruct[]>,
content: ITimestampStruct[],
): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
- content: ITimestampStruct[]
Returns void
Inherited from AbstractRga.mergeContent
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:579

`Protected`mergeTombstones

mergeTombstones(
ch1: Chunk<ITimestampStruct[]>,
ch2: Chunk<ITimestampStruct[]>,
): boolean
Parameters
- ch1: Chunk<ITimestampStruct[]>
- ch2: Chunk<ITimestampStruct[]>
Returns boolean
Inherited from AbstractRga.mergeTombstones
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:657

`Protected`mergeTombstones2

mergeTombstones2(
start: Chunk<ITimestampStruct[]>,
end: Chunk<ITimestampStruct[]>,
): void
Parameters
- start: Chunk<ITimestampStruct[]>
- end: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.mergeTombstones2
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:669

name

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

Returns string
Implementation of JsonNode.name
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:230

next(curr: Chunk<ITimestampStruct[]>): undefined | Chunk<ITimestampStruct[]>
Parameters
- curr: Chunk<ITimestampStruct[]>
Returns undefined | Chunk<ITimestampStruct[]>
Todo
Or better remove this method completely, as it does not require "this".
Inherited from AbstractRga.next
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:476

pos

pos(chunk: Chunk<ITimestampStruct[]>): number
Returns the position of the first element in the chunk.
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns number
Inherited from AbstractRga.pos
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:498

prev(curr: Chunk<ITimestampStruct[]>): undefined | Chunk<ITimestampStruct[]>
Parameters
- curr: Chunk<ITimestampStruct[]>
Returns undefined | Chunk<ITimestampStruct[]>
Todo
Or better remove this method completely, as it does not require "this".
Inherited from AbstractRga.prev
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:482

prevId

prevId(id: ITimestampStruct): undefined | ITimestampStruct
Parameters
- id: ITimestampStruct
  ID of character to start the search from.
Returns undefined | ITimestampStruct
Previous ID in the RGA sequence.
Inherited from AbstractRga.prevId
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:800

range0

range0(
    startChunk: undefined | Chunk<ITimestampStruct[]>,
    from: ITimestampStruct,
    to: ITimestampStruct,
    callback: (
        chunk: Chunk<ITimestampStruct[]>,
        off: number,
        len: number,
    ) => boolean | void,
): void | Chunk<ITimestampStruct[]>
Parameters
- startChunk: undefined | Chunk<ITimestampStruct[]>
  Chunk from which to start the range. If undefined, the chunk containing from will be used. This is an optimization to avoid a lookup.
- from: ITimestampStruct
  ID of the first element in the range.
- to: ITimestampStruct
  ID of the last element in the range.
- callback: (chunk: Chunk<ITimestampStruct[]>, off: number, len: number) => boolean | void
  Function to call for each chunk slice in the range. If it returns truthy value, the iteration will stop.
Returns void | Chunk<ITimestampStruct[]>
Reference to the last chunk in the range.

Note
All ".rangeX()" method are not performance optimized. For hot paths it is better to hand craft the loop.
Inherited from AbstractRga.range0
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:408

removeTombstones

removeTombstones(): void
Returns void
Inherited from AbstractRga.removeTombstones
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:690

setRoot

setRoot(chunk: Chunk<ITimestampStruct[]>): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.setRoot
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:511

size

size(): number
Number of chunks.

Returns number
Inherited from AbstractRga.size
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:493

spanView

spanView(span: ITimespanStruct): ITimestampStruct[][]
Parameters
- span: ITimespanStruct
Returns ITimestampStruct[][]
Inherited from AbstractRga.spanView
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:812

splay

splay(chunk: Chunk<ITimestampStruct[]>): void
Parameters
- chunk: Chunk<ITimestampStruct[]>
Returns void
Inherited from AbstractRga.splay
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:850

`Protected`split

split(
chunk: Chunk<ITimestampStruct[]>,
ticks: number,
): Chunk<ITimestampStruct[]>
Parameters
- chunk: Chunk<ITimestampStruct[]>
- ticks: number
Returns Chunk<ITimestampStruct[]>
Inherited from AbstractRga.split
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:643

toString

toString(tab?: string): string
Parameters
- tab: string = ''
Returns string
Implementation of JsonNode.toString
Inherited from AbstractRga.toString
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:938

`Protected`toStringName

toStringName(): string
Returns string
Overrides AbstractRga.toStringName
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:170

upd

upd(ref: ITimestampStruct, val: ITimestampStruct): undefined | ITimestampStruct
Updates an array element in-place. Used by the "upd_arr" operation.
Parameters
- ref: ITimestampStruct
  A reference to the element slot in the array.
- val: ITimestampStruct
  A new value to set in the slot.
Returns undefined | ITimestampStruct
The old value of the slot, if any.

Todo
Verify that the new ID is greater than the old ID.
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:147

view

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

Returns JsonNodeView<Element>[]
Implementation of JsonNode.view
Overrides AbstractRga.view
- Defined in src/json-crdt/nodes/arr/ArrNode.ts:190

Class ArrNode<Element>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArrNode<Element>

Properties

count

Readonlydoc

Readonlyid

ids

root

Methods

delete

Parameters

Returns void

deleteChunk

Parameters

Returns void

ProtecteddeleteId

Parameters

Returns void

ProtecteddeleteSpan

Parameters

Returns void

find

Parameters

Returns undefined | ITimestampStruct

findById

Parameters

Returns undefined | Chunk<ITimestampStruct[]>

findChunk

Parameters

Returns undefined | [chunk: Chunk<ITimestampStruct[]>, offset: number]

findInterval

Parameters

Returns ITimespanStruct[]

findInterval2

Parameters

Returns ITimespanStruct[]

first

Returns undefined | Chunk<ITimestampStruct[]>

ProtectedformatChunk

Parameters

Returns string

get

Parameters

Returns undefined | ITimestampStruct

getById

Parameters

Returns undefined | ITimestampStruct

getId

Parameters

Returns undefined | ITimestampStruct

Todo

getNode

Parameters

Returns undefined | JsonNode<unknown>

ingest

Parameters

Returns void

ins

Parameters

Returns void

ProtectedinsAfterChunk

Parameters

Returns void

ProtectedinsAfterRoot

Parameters

Returns void

insAt

Parameters

Returns undefined | ITimestampStruct

`Readonly`doc

`Readonly`id

`Protected`deleteId

`Protected`deleteSpan

`Protected`formatChunk

`Protected`insAfterChunk

`Protected`insAfterRoot

`Protected`insertAfterRef

`Protected`insertInside

`Protected`mergeContent

`Protected`mergeTombstones

`Protected`mergeTombstones2

`Protected`split