Class StrApi

Local changes API for the str JSON CRDT node StrNode. This API allows to insert and delete bytes in the UTF-16 string by referencing its local character positions.

Hierarchy (view full)

Constructors

constructor

Properties

api node

Accessors

events

Methods

arr asArr asBin asCon asExt asObj asStr asVal asVec bin con del find findId findPos in ins length obj proxy str toString val vec view

Constructors

constructor

Properties

Readonly api

api: ModelApi<any>

node

node: StrNode<string>

Accessors

events

  • get events(): NodeEvents<N>

  • Event target for listening to node changes. You can subscribe to "view" events, which are triggered every time the node's view changes.

    node.events.on('view', () => {
      // do something...
    });

    Returns NodeEvents<N>

Methods

arr

asArr

asBin

asCon

asExt

  • asExt(): undefined | ExtApi<any>

  • Returns the API object of the extension if the node is an extension node. When the ext parameter is provided, it checks if the node is an instance of the given extension and returns the object's TypeScript type. Otherwise, it returns the API object of the extension, but without any type checking.

    Returns undefined | ExtApi<any>

    API of the extension

  • asExt<EN, EApi>(ext): EApi

  • Type Parameters

    • EN extends ExtNode<any, any>
    • EApi extends ExtApi<EN>

    Parameters

    • ext: Extension<any, any, EN, EApi, any, any>

    Returns EApi

asObj

asStr

asVal

asVec

bin

con

del

  • del(index, length): void

  • Deletes a range of text at a given position.

    Parameters

    • index: number

      Position at which to delete text.

    • length: number

      Number of UTF-16 code units to delete.

    Returns void

    Reference to itself.

find

findId

  • findId(index): ITimestampStruct

  • Given a character index in local coordinates, find the ID of the character in the global coordinates.

    Parameters

    • index: number

      Index of the character or -1 for before the first character.

    Returns ITimestampStruct

    ID of the character after which the given position is located.

findPos

  • findPos(id): number

  • Given a position in global coordinates, find the position in local coordinates.

    Parameters

    Returns number

    Index of the character in local coordinates. Returns -1 if the the position refers to the beginning of the string.

in

ins

  • ins(index, text): void

  • Inserts text at a given position.

    Parameters

    • index: number

      Position at which to insert text.

    • text: string

      Text to insert.

    Returns void

    Reference to itself.

length

obj

proxy

str

toString

val

vec

view

Settings

Member Visibility

Theme

On This Page

constructorapinodeeventsarrasArrasBinasConasExtasObjasStrasValasVecbincondelfindfindIdfindPosininslengthobjproxystrtoStringvalvecview