loro-crdt - npm Package Compare versions

Comparing version 0.16.3 to 0.16.4-alpha.0

dist/loro.d.ts

@@ -504,2 +504,22 @@ import { Value, AwarenessWasm, PeerID as PeerID$1, Container, ContainerID, TreeID, OpId, Delta, LoroText, LoroMap, LoroTree, LoroList } from 'loro-wasm';
         new (): LoroTree<T>;
+        /**
+         * Create a new tree node as the child of parent and return a `LoroTreeNode` instance.
+         * If the parent is undefined, the tree node will be a root node.
+         *
+         * If the index is not provided, the new node will be appended to the end.
+         *
+         * @example
+         * ```ts
+         * import { Loro } from "loro-crdt";
+         *
+         * const doc = new Loro();
+         * const tree = doc.getTree("tree");
+         * const root = tree.createNode();
+         * const node = tree.createNode(undefined, 0);
+         *
+         * //  undefined
+         * //    /   \
+         * // node  root
+         * ```
+         */
         createNode(parent?: TreeID, index?: number): LoroTreeNode<T>;
@@ -509,3 +529,6 @@ move(target: TreeID, parent?: TreeID, index?: number): void;
         has(target: TreeID): boolean;
-        getNodeByID(target: TreeID): LoroTreeNode;
+        /**
+         * Get LoroTreeNode by the TreeID.
+         */
+        getNodeByID(target: TreeID): LoroTreeNode<T>;
         subscribe(listener: Listener): number;
@@ -518,5 +541,31 @@ }
         readonly data: LoroMap<T>;
+        /**
+         * Create a new node as the child of the current node and
+         * return an instance of `LoroTreeNode`.
+         *
+         * If the index is not provided, the new node will be appended to the end.
+         *
+         * @example
+         * ```typescript
+         * import { Loro } from "loro-crdt";
+         *
+         * let doc = new Loro();
+         * let tree = doc.getTree("tree");
+         * let root = tree.createNode();
+         * let node = root.createNode();
+         * let node2 = root.createNode(0);
+         * //    root
+         * //    /  \
+         * // node2 node
+         * ```
+         */
         createNode(index?: number): LoroTreeNode<T>;
         move(parent?: LoroTreeNode<T>, index?: number): void;
         parent(): LoroTreeNode<T> | undefined;
+        /**
+         * Get the children of this node.
+         *
+         * The objects returned are new js objects each time because they need to cross
+         * the WASM boundary.
+         */
         children(): Array<LoroTreeNode<T>>;
@@ -523,0 +572,0 @@ }

package.json

 {
   "name": "loro-crdt",
-  "version": "0.16.3",
+  "version": "0.16.4-alpha.0",
   "description": "Loro CRDTs is a high-performance CRDT framework that makes your app state synchronized, collaborative and maintainable effortlessly.",
@@ -20,3 +20,3 @@ "keywords": [
   "dependencies": {
-    "loro-wasm": "0.16.3"
+    "loro-wasm": "0.16.4-alpha.0"
   },
@@ -23,0 +23,0 @@ "devDependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

79476

increased by5.91%

Lines of code

800

increased by6.52%

Dependency changes

• + Addedloro-wasm@0.16.4-alpha.0(transitive)

• - Removedloro-wasm@0.16.3(transitive)

• Updatedloro-wasm@0.16.4-alpha.0