Class ObjApi<N>

constructor

• new ObjApi<N>(node, api): ObjApi<N>

• Type Parameters

  • N extends ObjNode<any> = ObjNode<any>

  Parameters

  • node: N
  • api: ModelApi<any>

  Returns ObjApi<N>

Readonly api

node

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...
  });
  Copy

  Returns NodeEvents<N>

arr

• arr(path?): ArrApi<ArrNode<any>>

• Parameters

  • Optional path: ApiPath

  Returns ArrApi<ArrNode<any>>

asArr

• asArr(): ArrApi<ArrNode<any>>

• Returns ArrApi<ArrNode<any>>

asBin

• asBin(): BinApi

• Returns BinApi

asCon

• asCon(): ConApi<ConNode<any>>

• Returns ConApi<ConNode<any>>

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

• asObj(): ObjApi<ObjNode<any>>

• Returns ObjApi<ObjNode<any>>

asStr

• asStr(): StrApi

• Returns StrApi

asVal

• asVal(): ValApi<ValNode<any>>

• Returns ValApi<ValNode<any>>

asVec

• asVec(): VecApi<VecNode<any>>

• Returns VecApi<VecNode<any>>

bin

• bin(path?): BinApi

• Parameters

  • Optional path: ApiPath

  Returns BinApi

con

• con(path?): ConApi<ConNode<any>>

• Parameters

  • Optional path: ApiPath

  Returns ConApi<ConNode<any>>

find

• find(path?): JsonNode<unknown>

• Find a child node at the given path starting from this node.

  Parameters

  • Optional path: ApiPath

    Path to the child node to find.

  Returns JsonNode<unknown>

  JSON CRDT node at the given path.

in

• in(path?): ValApi<ValNode<any>>

• Find a child node at the given path starting from this node and wrap it in a local changes API.

  Parameters

  • Optional path: ApiPath

    Path to the child node to find.

  Returns ValApi<ValNode<any>>

  Local changes API for the child node at the given path.

obj

• obj(path?): ObjApi<ObjNode<any>>

• Parameters

  • Optional path: ApiPath

  Returns ObjApi<ObjNode<any>>

str

• str(path?): StrApi

• Parameters

  • Optional path: ApiPath

  Returns StrApi

toString

• toString(tab?): string

• Parameters

  • tab: string = ''

  Returns string

val

• val(path?): ValApi<ValNode<any>>

• Parameters

  • Optional path: ApiPath

  Returns ValApi<ValNode<any>>

vec

• vec(path?): VecApi<VecNode<any>>

• Parameters

  • Optional path: ApiPath

  Returns VecApi<VecNode<any>>

view

• view(): JsonNodeView<N>

• Returns JsonNodeView<N>