Class BinApi

Readonlyapi

node

$

• get $(): JsonNodeToProxyPathNode<N>

  Returns JsonNodeToProxyPathNode<N>

add

• add(path: ApiPath, value: unknown): boolean

  Parameters

  • path: ApiPath
  • value: unknown

  Returns boolean

arr

• arr(path?: ApiPath): ArrApi

  Parameters

  • Optionalpath: ApiPath

  Returns ArrApi

asArr

• asArr(): ArrApi

  Returns ArrApi

asBin

• asBin(): BinApi

  Returns BinApi

asCon

• asCon(): ConApi

  Returns ConApi

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 extends ExtNode<any, any>, EApi extends ExtApi<EN>>(
      ext: Extension<any, any, EN, EApi, any, any>,
  ): EApi

  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.

  Type Parameters

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

  Parameters

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

    Extension of the node

  Returns EApi

  API of the extension

asObj

• asObj(): ObjApi

  Returns ObjApi

asStr

• asStr(): StrApi

  Returns StrApi

asVal

• asVal(): ValApi

  Returns ValApi

asVec

• asVec(): VecApi

  Returns VecApi

bin

• bin(path?: ApiPath): BinApi

  Parameters

  • Optionalpath: ApiPath

  Returns BinApi

con

• con(path?: ApiPath): ConApi

  Parameters

  • Optionalpath: ApiPath

  Returns ConApi

diff

• diff(value: unknown): undefined | Patch

  Parameters

  • value: unknown

  Returns undefined | Patch

find

• find(path?: ApiPath): JsonNode

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

  Parameters

  • Optionalpath: ApiPath

    Path to the child node to find.

  Returns JsonNode

  JSON CRDT node at the given path.

in

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

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

  Parameters

  • Optionalpath: ApiPath

    Path to the child node to find.

  Returns ValApi<ValNode<any>>

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

merge

• merge(value: unknown): undefined | Patch

  Parameters

  • value: unknown

  Returns undefined | Patch

obj

• obj(path?: ApiPath): ObjApi

  Parameters

  • Optionalpath: ApiPath

  Returns ObjApi

onChildChange

• onChildChange(
      listener: (event: ChangeEvent) => void,
      onReset?: boolean,
  ): FanOutUnsubscribe

  Attaches a listener which executes on every change that is applied to this node's children. Hence, this listener will trigger only for container nodes - nodes that can have child nodes, such as "obj", "arr", "vec", and "val" nodes. It will not execute on changes made directly to this node.

  If you want to listen to changes on this node as well as its children, use onSubtreeChange() method. If you want to listen to changes on this node only, use onSelfChange() method.

  Parameters

  • listener: (event: ChangeEvent) => void

    Callback called on every change that is applied to children of this node.
  • OptionalonReset: boolean

    Optional parameter, if set to true, the listener will also be called when the model is reset using the .reset() method.

  Returns FanOutUnsubscribe

  Returns an unsubscribe function to stop listening to the events.

  See

  • onSelfChange()
  • onSubtreeChange()

onSelfChange

• onSelfChange(
      listener: (event: ChangeEvent) => void,
      onReset?: boolean,
  ): FanOutUnsubscribe

  Attaches a listener which executes on every change that is executed directly on this node. For example, if this is a "str" string node and you insert or delete text, the listener will be executed. Or if this is an "obj" object node and keys of this object are changed, this listener will be executed.

  It does not trigger when child nodes are edit, to include those changes, use onSubtreeChange() or onChildChange() methods.

  Parameters

  • listener: (event: ChangeEvent) => void

    Callback called on every change that is executed directly on this node.
  • OptionalonReset: boolean

    Optional parameter, if set to true, the listener will also be called when the model is reset using the .reset() method.

  Returns FanOutUnsubscribe

  Returns an unsubscribe function to stop listening to the events.

  See

  • onChildChange()
  • onSubtreeChange()

onSubtreeChange

• onSubtreeChange(
      listener: (event: ChangeEvent) => void,
      onReset?: boolean,
  ): FanOutUnsubscribe

  Attaches a listener which executes on every change that is applied to this node or any of its child nodes (recursively). This is equivalent to combining both onSelfChange() and onChildChange() methods.

  Parameters

  • listener: (event: ChangeEvent) => void

    Callback called on every change that is applied to this node or any of its child nodes.
  • OptionalonReset: boolean

    Optional parameter, if set to true, the listener will also be called when the model is reset using the .reset() method.

  Returns FanOutUnsubscribe

  Returns an unsubscribe function to stop listening to the events.

  See

  • onSelfChange()
  • onChildChange()

op

• op(operation: ApiOperation): boolean

  Parameters

  • operation: ApiOperation

  Returns boolean

read

• read(path?: ApiPath): unknown

  Parameters

  • Optionalpath: ApiPath

  Returns unknown

remove

• remove(path: ApiPath, length?: number): boolean

  Parameters

  • path: ApiPath
  • length: number = 1

  Returns boolean

replace

• replace(path: ApiPath, value: unknown): boolean

  Parameters

  • path: ApiPath
  • value: unknown

  Returns boolean

select

• select(path?: ApiPath, leaf?: boolean): undefined | NodeApi<JsonNode<unknown>>

  Parameters

  • Optionalpath: ApiPath
  • Optionalleaf: boolean

  Returns undefined | NodeApi<JsonNode<unknown>>

str

• str(path?: ApiPath): StrApi

  Parameters

  • Optionalpath: ApiPath

  Returns StrApi

toString

• toString(tab?: string): string

  Parameters

  • tab: string = ''

  Returns string

val

• val(path?: ApiPath): ValApi

  Parameters

  • Optionalpath: ApiPath

  Returns ValApi

vec

• vec(path?: ApiPath): VecApi

  Parameters

  • Optionalpath: ApiPath

  Returns VecApi

view

• view(): Uint8Array<ArrayBufferLike>

  Returns Uint8Array<ArrayBufferLike>