json-joy
    Preparing search index...

    Class BinApi

    Local changes API for the bin JSON CRDT node BinNode. This API allows to insert and delete bytes in the binary string by referencing their local index.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    api: ModelApi<any>
    node: BinNode

    Accessors

    • 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

    • 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

    • 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

    • Deletes a range of octets at a given position.

      Parameters

      • index: number

        Position at which to delete octets.

      • length: number

        Number of octets to delete.

      Returns void

      Reference to itself.

    • 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.

    • Inserts octets at a given position.

      Parameters

      • index: number

        Position at which to insert octets.

      • data: Uint8Array

        Octets to insert.

      Returns void

      Reference to itself.