Skip to content

Commit d766fe9

Browse files
committed
fix: updating docs
1 parent 2b29208 commit d766fe9

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

libs/js-tuple/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# js-tuple
22

33
A high-performance JavaScript library for managed nested maps, nested set and creating immutable, cached tuples that can be safely used as Map keys.
4+
The Nested classes are also high-performant and strong tree structures that can be used for high configurable traversals
45

56
## Why js-tuple?
67

@@ -217,6 +218,7 @@ For complex scenarios—such as custom traversal orders, subtree iteration, or p
217218
- **NestedMap:** See [Advanced NestedMap.entries](https://github.com/codibre/js-utils/blob/main/libs/js-tuple/docs/nestedmap-entries-advanced.md) for details on traversal modes, yield order, edge cases, and performance considerations.
218219
- **NestedSet:** See [Advanced NestedSet](https://github.com/codibre/js-utils/blob/main/libs/js-tuple/docs/nestedset-advanced.md) for set-specific traversal, subtree operations, and advanced patterns.
219220
- **Traversal Performance:** See [Traversal Performance](https://github.com/codibre/js-utils/blob/main/libs/js-tuple/docs/traversal-performance.md) for detailed benchmarks, memory insights, and practical guidance on choosing the best traversal mode for your use case.
221+
- **SubMaps and Cloning:** See [Methods to Obtain Subtrees in NestedMap](https://github.com/codibre/js-utils/blob/main/libs/js-tuple/docs/advanced-getsubmap-example.md) for good insights about working with submaps (which can perform incredibly good for bulk operations) or deep clones of maps and submaps.
220222

221223
These guides cover:
222224
- How to use `basePath` for partial/subtree traversal

libs/js-tuple/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "js-tuple",
33
"version": "0.4.0",
4-
"description": "High performance tuples for Map/Set indexing",
4+
"description": "High performance tuples for Map/Set indexing, NestedMap/NestedSet, and trees.",
55
"main": "dist/index.js",
66
"exports": {
77
".": {
@@ -53,7 +53,8 @@
5353
"bfs",
5454
"data structure",
5555
"tree",
56-
"graph"
56+
"graph",
57+
"traversal"
5758
],
5859
"author": "Farenheith",
5960
"license": "MIT",

0 commit comments

Comments
 (0)