json-joy
    Preparing search index...

    Class NodeApi<N>

    A generic local changes API for a JSON CRDT node.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    • Printable
    Index

    Constructors

    constructor

    Properties

    api node

    Accessors

    $ events s

    Methods

    add arr asArr asBin asCon asExt asObj asStr asVal asVec bin con diff find in merge obj op read remove replace select str toString val vec view

    Constructors

    Properties

    api: ModelApi<any>
    node: N

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods