Class ArrApi<N>

Local changes API for the arr JSON CRDT node ArrNode. This API allows to insert and delete elements in the array by referencing their local index.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

api node

Accessors

events

Methods

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

Constructors

constructor

Properties

Readonly api

api: ModelApi<any>

node

node: N

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> | JsonNodeApi<VecNodeExtensionData<N>>

  • 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> | JsonNodeApi<VecNodeExtensionData<N>>

    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 elements at a given position.

    Parameters

    • index: number

      Position at which to delete elements.

    • length: number

      Number of elements to delete.

    Returns void

    Reference to itself.

find

get

  • get(index): JsonNodeApi<UnArrNode<N>>

  • Get API instance of a child node.

    Parameters

    • index: number

      Index of the element to get.

    Returns JsonNodeApi<UnArrNode<N>>

    Child node API for the element at the given index.

in

ins

  • ins(index, values): void

  • Inserts elements at a given position.

    Parameters

    • index: number

      Position at which to insert elements.

    • values: JsonNodeView<N>[number][]

      JSON/CBOR values or IDs of the values to insert.

    Returns void

    Reference to itself.

length

obj

proxy

str

toString

val

vec

view

Settings

Member Visibility

Theme

On This Page

constructorapinodeeventsarrasArrasBinasConasExtasObjasStrasValasVecbincondelfindgetininslengthobjproxystrtoStringvalvecview