Class StrNode<T>

Represents the str type in JSON CRDT. The str type is a RGA (Replicated Growable Array) of UTF-16 code units.

Type Parameters

T extends string = string

Hierarchy

AbstractRga<string>
- StrNode

Implements

JsonNode<string>

Constructors

constructor

new StrNode<T extends string = string>(id: ITimestampStruct): StrNode<T>
Type Parameters
- T extends string = string
Parameters
- id: ITimestampStruct
Returns StrNode<T>
Inherited from AbstractRga<string>.constructor
- Defined in packages/json-joy/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<string> = undefined

root

root: undefined | Chunk<string> = undefined

Methods

delete

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

deleteChunk

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

`Protected`deleteId

deleteId(chunk: Chunk<string>): void
Parameters
- chunk: Chunk<string>
Returns void
Inherited from AbstractRga.deleteId
- Defined in packages/json-joy/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 packages/json-joy/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 packages/json-joy/src/json-crdt/nodes/rga/AbstractRga.ts:298

findById

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

findChunk

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

first

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

`Protected`formatChunk

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

ingest

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

ins

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

`Protected`insAfterChunk

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

`Protected`insAfterRoot

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

insAt

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

insertAfter

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

`Protected`insertAfterRef

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

insertBefore

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

insertId

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

insertIdFast

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

`Protected`insertInside

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

iterator

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

last

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

lastId

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

length

length(): number
Content length.

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

`Protected`mergeContent

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

`Protected`mergeTombstones

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

`Protected`mergeTombstones2

mergeTombstones2(start: Chunk<string>, end: Chunk<string>): void
Parameters
- start: Chunk<string>
- end: Chunk<string>
Returns void
Inherited from AbstractRga.mergeTombstones2
- Defined in packages/json-joy/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 packages/json-joy/src/json-crdt/nodes/str/StrNode.ts:107

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

pos

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

prev(curr: Chunk<string>): undefined | Chunk<string>
Parameters
- curr: Chunk<string>
Returns undefined | Chunk<string>
Todo
Or better remove this method completely, as it does not require "this".
Inherited from AbstractRga.prev
- Defined in packages/json-joy/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 packages/json-joy/src/json-crdt/nodes/rga/AbstractRga.ts:800

`Protected`printChunk

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

range0

range0(
    startChunk: undefined | Chunk<string>,
    from: ITimestampStruct,
    to: ITimestampStruct,
    callback: (
        chunk: Chunk<string>,
        off: number,
        len: number,
    ) => boolean | void,
): void | Chunk<string>
Parameters
- startChunk: undefined | Chunk<string>
  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<string>, 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<string>
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 packages/json-joy/src/json-crdt/nodes/rga/AbstractRga.ts:408

removeTombstones

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

setRoot

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

size

size(): number
Number of chunks.

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

spanView

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

splay

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

`Protected`split

split(chunk: Chunk<string>, ticks: number): Chunk<string>
Parameters
- chunk: Chunk<string>
- ticks: number
Returns Chunk<string>
Inherited from AbstractRga.split
- Defined in packages/json-joy/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 packages/json-joy/src/json-crdt/nodes/rga/AbstractRga.ts:938

`Protected`toStringName

toStringName(): string
Returns string
Overrides AbstractRga.toStringName
- Defined in packages/json-joy/src/json-crdt/nodes/str/StrNode.ts:123

view

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

Returns T
Implementation of JsonNode.view
Overrides AbstractRga.view
- Defined in packages/json-joy/src/json-crdt/nodes/str/StrNode.ts:95

Class StrNode<T>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StrNode<T>

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<string>

findChunk

Parameters

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

findInterval

Parameters

Returns ITimespanStruct[]

findInterval2

Parameters

Returns ITimespanStruct[]

first

Returns undefined | Chunk<string>

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

`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