Class BinNode

Represents the bin type in JSON CRDT. The bin is a blob of binary data, powered by a Replicated Growable Array (RGA) algorithm.

Hierarchy

AbstractRga<Uint8Array>
- BinNode

Implements

JsonNode<Uint8Array>

Constructors

constructor

new BinNode(id: ITimestampStruct): BinNode
Parameters
- id: ITimestampStruct
Returns BinNode
Inherited from AbstractRga<Uint8Array>.constructor
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:131

Properties

count

count: number = 0

`Readonly`id

id: ITimestampStruct

Unique ID within a document.

ids

ids: undefined | Chunk<Uint8Array<ArrayBufferLike>> = undefined

root

root: undefined | Chunk<Uint8Array<ArrayBufferLike>> = 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<Uint8Array<ArrayBufferLike>>): void
Parameters
- chunk: Chunk<Uint8Array<ArrayBufferLike>>
Returns void
Inherited from AbstractRga.deleteChunk
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:700

`Protected`deleteId

deleteId(chunk: Chunk<Uint8Array<ArrayBufferLike>>): void
Parameters
- chunk: Chunk<Uint8Array<ArrayBufferLike>>
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<Uint8Array<ArrayBufferLike>>
Parameters
- after: ITimestampStruct
Returns undefined | Chunk<Uint8Array<ArrayBufferLike>>
Inherited from AbstractRga.findById
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:758

findChunk

findChunk(
position: number,
): undefined | [chunk: Chunk<Uint8Array<ArrayBufferLike>>, offset: number]
Parameters
- position: number
Returns undefined | [chunk: Chunk<Uint8Array<ArrayBufferLike>>, 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<Uint8Array<ArrayBufferLike>>
Returns undefined | Chunk<Uint8Array<ArrayBufferLike>>
Inherited from AbstractRga.first
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:446

`Protected`formatChunk

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

ingest

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

ins

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

`Protected`insAfterChunk

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

`Protected`insAfterRoot

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

insAt

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

insertAfter

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

`Protected`insertAfterRef

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

insertBefore

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

insertId

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

insertIdFast

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

`Protected`insertInside

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

iterator

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

last

last(): undefined | Chunk<Uint8Array<ArrayBufferLike>>
Returns undefined | Chunk<Uint8Array<ArrayBufferLike>>
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<Uint8Array<ArrayBufferLike>>,
content: Uint8Array,
): void
Parameters
- chunk: Chunk<Uint8Array<ArrayBufferLike>>
- content: Uint8Array
Returns void
Inherited from AbstractRga.mergeContent
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:579

`Protected`mergeTombstones

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

`Protected`mergeTombstones2

mergeTombstones2(
start: Chunk<Uint8Array<ArrayBufferLike>>,
end: Chunk<Uint8Array<ArrayBufferLike>>,
): void
Parameters
- start: Chunk<Uint8Array<ArrayBufferLike>>
- end: Chunk<Uint8Array<ArrayBufferLike>>
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/bin/BinNode.ts:116

next(
curr: Chunk<Uint8Array<ArrayBufferLike>>,
): undefined | Chunk<Uint8Array<ArrayBufferLike>>
Parameters
- curr: Chunk<Uint8Array<ArrayBufferLike>>
Returns undefined | Chunk<Uint8Array<ArrayBufferLike>>
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<Uint8Array<ArrayBufferLike>>): number
Returns the position of the first element in the chunk.
Parameters
- chunk: Chunk<Uint8Array<ArrayBufferLike>>
Returns number
Inherited from AbstractRga.pos
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:498

prev(
curr: Chunk<Uint8Array<ArrayBufferLike>>,
): undefined | Chunk<Uint8Array<ArrayBufferLike>>
Parameters
- curr: Chunk<Uint8Array<ArrayBufferLike>>
Returns undefined | Chunk<Uint8Array<ArrayBufferLike>>
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

`Protected`printChunk

printChunk(tab: string, chunk: Chunk<Uint8Array<ArrayBufferLike>>): string
Parameters
- tab: string
- chunk: Chunk<Uint8Array<ArrayBufferLike>>
Returns string
Inherited from AbstractRga.printChunk
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:948

range0

range0(
    startChunk: undefined | Chunk<Uint8Array<ArrayBufferLike>>,
    from: ITimestampStruct,
    to: ITimestampStruct,
    callback: (
        chunk: Chunk<Uint8Array<ArrayBufferLike>>,
        off: number,
        len: number,
    ) => boolean | void,
): void | Chunk<Uint8Array<ArrayBufferLike>>
Parameters
- startChunk: undefined | Chunk<Uint8Array<ArrayBufferLike>>
  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<Uint8Array<ArrayBufferLike>>,
      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<Uint8Array<ArrayBufferLike>>
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<Uint8Array<ArrayBufferLike>>): void
Parameters
- chunk: Chunk<Uint8Array<ArrayBufferLike>>
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): Uint8Array<ArrayBufferLike>[]
Parameters
- span: ITimespanStruct
Returns Uint8Array<ArrayBufferLike>[]
Inherited from AbstractRga.spanView
- Defined in src/json-crdt/nodes/rga/AbstractRga.ts:812

splay

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

`Protected`split

split(
chunk: Chunk<Uint8Array<ArrayBufferLike>>,
ticks: number,
): Chunk<Uint8Array<ArrayBufferLike>>
Parameters
- chunk: Chunk<Uint8Array<ArrayBufferLike>>
- ticks: number
Returns Chunk<Uint8Array<ArrayBufferLike>>
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/bin/BinNode.ts:132

view

view(): Uint8Array
Returns a POJO object which represents the "view" of this JSON node model.

Returns Uint8Array
Implementation of JsonNode.view
Overrides AbstractRga.view
- Defined in src/json-crdt/nodes/bin/BinNode.ts:84

Class BinNode

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BinNode

Properties

count

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<Uint8Array<ArrayBufferLike>>

findChunk

Parameters

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

findInterval

Parameters

Returns ITimespanStruct[]

findInterval2

Parameters

Returns ITimespanStruct[]

first

Returns undefined | Chunk<Uint8Array<ArrayBufferLike>>

ProtectedformatChunk

Parameters

Returns string

ingest

Parameters

Returns void

ins

Parameters

Returns void

ProtectedinsAfterChunk

Parameters

Returns void

ProtectedinsAfterRoot

Parameters

Returns void

insAt

Parameters

Returns undefined | ITimestampStruct

insertAfter

Parameters

Returns void

ProtectedinsertAfterRef

Parameters

Returns void

insertBefore

Parameters

Returns void

insertId

Parameters

Returns void

insertIdFast

Parameters

Returns void

ProtectedinsertInside

`Readonly`id

`Protected`deleteId

`Protected`deleteSpan

`Protected`formatChunk

`Protected`insAfterChunk

`Protected`insAfterRoot

`Protected`insertAfterRef

`Protected`insertInside

`Protected`mergeContent

`Protected`mergeTombstones

`Protected`mergeTombstones2

`Protected`printChunk

`Protected`split

`Protected`toStringName