loro-crdt 1.2.4 → 1.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2099,6 +2099,21 @@ export class LoroDoc {
2099
2099
  /**
2100
2100
  * Get the value or container at the given path
2101
2101
  *
2102
+ * The path can be specified in different ways depending on the container type:
2103
+ *
2104
+ * For Tree:
2105
+ * 1. Using node IDs: `tree/{node_id}/property`
2106
+ * 2. Using indices: `tree/0/1/property`
2107
+ *
2108
+ * For List and MovableList:
2109
+ * - Using indices: `list/0` or `list/1/property`
2110
+ *
2111
+ * For Map:
2112
+ * - Using keys: `map/key` or `map/nested/property`
2113
+ *
2114
+ * For tree structures, index-based paths follow depth-first traversal order.
2115
+ * The indices start from 0 and represent the position of a node among its siblings.
2116
+ *
2102
2117
  * @example
2103
2118
  * ```ts
2104
2119
  * import { LoroDoc } from "loro-crdt";
@@ -2359,6 +2359,21 @@ export class LoroDoc {
2359
2359
  /**
2360
2360
  * Get the value or container at the given path
2361
2361
  *
2362
+ * The path can be specified in different ways depending on the container type:
2363
+ *
2364
+ * For Tree:
2365
+ * 1. Using node IDs: `tree/{node_id}/property`
2366
+ * 2. Using indices: `tree/0/1/property`
2367
+ *
2368
+ * For List and MovableList:
2369
+ * - Using indices: `list/0` or `list/1/property`
2370
+ *
2371
+ * For Map:
2372
+ * - Using keys: `map/key` or `map/nested/property`
2373
+ *
2374
+ * For tree structures, index-based paths follow depth-first traversal order.
2375
+ * The indices start from 0 and represent the position of a node among its siblings.
2376
+ *
2362
2377
  * @example
2363
2378
  * ```ts
2364
2379
  * import { LoroDoc } from "loro-crdt";
Binary file
@@ -2099,6 +2099,21 @@ export class LoroDoc {
2099
2099
  /**
2100
2100
  * Get the value or container at the given path
2101
2101
  *
2102
+ * The path can be specified in different ways depending on the container type:
2103
+ *
2104
+ * For Tree:
2105
+ * 1. Using node IDs: `tree/{node_id}/property`
2106
+ * 2. Using indices: `tree/0/1/property`
2107
+ *
2108
+ * For List and MovableList:
2109
+ * - Using indices: `list/0` or `list/1/property`
2110
+ *
2111
+ * For Map:
2112
+ * - Using keys: `map/key` or `map/nested/property`
2113
+ *
2114
+ * For tree structures, index-based paths follow depth-first traversal order.
2115
+ * The indices start from 0 and represent the position of a node among its siblings.
2116
+ *
2102
2117
  * @example
2103
2118
  * ```ts
2104
2119
  * import { LoroDoc } from "loro-crdt";
@@ -2357,6 +2357,21 @@ class LoroDoc {
2357
2357
  /**
2358
2358
  * Get the value or container at the given path
2359
2359
  *
2360
+ * The path can be specified in different ways depending on the container type:
2361
+ *
2362
+ * For Tree:
2363
+ * 1. Using node IDs: `tree/{node_id}/property`
2364
+ * 2. Using indices: `tree/0/1/property`
2365
+ *
2366
+ * For List and MovableList:
2367
+ * - Using indices: `list/0` or `list/1/property`
2368
+ *
2369
+ * For Map:
2370
+ * - Using keys: `map/key` or `map/nested/property`
2371
+ *
2372
+ * For tree structures, index-based paths follow depth-first traversal order.
2373
+ * The indices start from 0 and represent the position of a node among its siblings.
2374
+ *
2360
2375
  * @example
2361
2376
  * ```ts
2362
2377
  * import { LoroDoc } from "loro-crdt";
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "loro-crdt",
3
- "version": "1.2.4",
3
+ "version": "1.2.6",
4
4
  "description": "Loro CRDTs is a high-performance CRDT framework that makes your app state synchronized, collaborative and maintainable effortlessly.",
5
5
  "keywords": [
6
6
  "crdt",
@@ -2099,6 +2099,21 @@ export class LoroDoc {
2099
2099
  /**
2100
2100
  * Get the value or container at the given path
2101
2101
  *
2102
+ * The path can be specified in different ways depending on the container type:
2103
+ *
2104
+ * For Tree:
2105
+ * 1. Using node IDs: `tree/{node_id}/property`
2106
+ * 2. Using indices: `tree/0/1/property`
2107
+ *
2108
+ * For List and MovableList:
2109
+ * - Using indices: `list/0` or `list/1/property`
2110
+ *
2111
+ * For Map:
2112
+ * - Using keys: `map/key` or `map/nested/property`
2113
+ *
2114
+ * For tree structures, index-based paths follow depth-first traversal order.
2115
+ * The indices start from 0 and represent the position of a node among its siblings.
2116
+ *
2102
2117
  * @example
2103
2118
  * ```ts
2104
2119
  * import { LoroDoc } from "loro-crdt";
package/web/loro_wasm.js CHANGED
@@ -2351,6 +2351,21 @@ export class LoroDoc {
2351
2351
  /**
2352
2352
  * Get the value or container at the given path
2353
2353
  *
2354
+ * The path can be specified in different ways depending on the container type:
2355
+ *
2356
+ * For Tree:
2357
+ * 1. Using node IDs: `tree/{node_id}/property`
2358
+ * 2. Using indices: `tree/0/1/property`
2359
+ *
2360
+ * For List and MovableList:
2361
+ * - Using indices: `list/0` or `list/1/property`
2362
+ *
2363
+ * For Map:
2364
+ * - Using keys: `map/key` or `map/nested/property`
2365
+ *
2366
+ * For tree structures, index-based paths follow depth-first traversal order.
2367
+ * The indices start from 0 and represent the position of a node among its siblings.
2368
+ *
2354
2369
  * @example
2355
2370
  * ```ts
2356
2371
  * import { LoroDoc } from "loro-crdt";
Binary file