data-structure-typed 1.31.0 → 1.32.0

package/docs/types/ObjectWithoutId.html

@@ -17,7 +17,7 @@
 <h1>Type alias ObjectWithoutId</h1></div>
 <div class="tsd-signature"><span class="tsd-kind-type-alias">Object<wbr/>Without<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="KeyValueObject.html" class="tsd-signature-type tsd-kind-type-alias">KeyValueObject</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;id&quot;</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/utils/validate-type.ts#L7">src/types/utils/validate-type.ts:7</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/utils/validate-type.ts#L7">src/types/utils/validate-type.ts:7</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/PriorityQueueComparator.html

@@ -37,7 +37,7 @@
 <h5><span class="tsd-kind-parameter">b</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/priority-queue.ts#L1">src/types/data-structures/priority-queue.ts:1</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/priority-queue.ts#L1">src/types/data-structures/priority-queue.ts:1</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/PriorityQueueDFSOrderPattern.html

@@ -17,7 +17,7 @@
 <h1>Type alias PriorityQueueDFSOrderPattern</h1></div>
 <div class="tsd-signature"><span class="tsd-kind-type-alias">Priority<wbr/>QueueDFSOrder<wbr/>Pattern</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pre&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;in&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;post&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/priority-queue.ts#L9">src/types/data-structures/priority-queue.ts:9</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/priority-queue.ts#L9">src/types/data-structures/priority-queue.ts:9</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/PriorityQueueOptions.html

@@ -31,7 +31,7 @@
 <li class="tsd-parameter">
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">nodes</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/priority-queue.ts#L3">src/types/data-structures/priority-queue.ts:3</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/priority-queue.ts#L3">src/types/data-structures/priority-queue.ts:3</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/RBTreeNodeNested.html

@@ -22,7 +22,7 @@
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/rb-tree.ts#L6">src/types/data-structures/rb-tree.ts:6</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/rb-tree.ts#L6">src/types/data-structures/rb-tree.ts:6</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/RBTreeOptions.html

@@ -20,7 +20,7 @@
 <h4>Type declaration</h4>
 <ul class="tsd-parameters"></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/rb-tree.ts#L8">src/types/data-structures/rb-tree.ts:8</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/rb-tree.ts#L8">src/types/data-structures/rb-tree.ts:8</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/RestrictValById.html

@@ -17,7 +17,7 @@
 <h1>Type alias RestrictValById</h1></div>
 <div class="tsd-signature"><span class="tsd-kind-type-alias">Restrict<wbr/>Val<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <a href="NonNumberNonObjectButDefined.html" class="tsd-signature-type tsd-kind-type-alias">NonNumberNonObjectButDefined</a><span class="tsd-signature-symbol"> | </span><a href="ObjectWithoutId.html" class="tsd-signature-type tsd-kind-type-alias">ObjectWithoutId</a><span class="tsd-signature-symbol"> | </span><a href="ObjectWithNonNumberId.html" class="tsd-signature-type tsd-kind-type-alias">ObjectWithNonNumberId</a><span class="tsd-signature-symbol"> | </span><a href="ObjectWithNumberId.html" class="tsd-signature-type tsd-kind-type-alias">ObjectWithNumberId</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/utils/validate-type.ts#L19">src/types/utils/validate-type.ts:19</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/utils/validate-type.ts#L19">src/types/utils/validate-type.ts:19</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/SegmentTreeNodeVal.html

@@ -17,7 +17,7 @@
 <h1>Type alias SegmentTreeNodeVal</h1></div>
 <div class="tsd-signature"><span class="tsd-kind-type-alias">Segment<wbr/>Tree<wbr/>Node<wbr/>Val</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/segment-tree.ts#L1">src/types/data-structures/segment-tree.ts:1</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/segment-tree.ts#L1">src/types/data-structures/segment-tree.ts:1</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/SpecifyOptional.html

@@ -24,7 +24,7 @@
 <li>
 <h4><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/utils/utils.ts#L6">src/types/utils/utils.ts:6</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/utils/utils.ts#L6">src/types/utils/utils.ts:6</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/Thunk.html

@@ -25,7 +25,7 @@
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="ToThunkFn.html" class="tsd-signature-type tsd-kind-type-alias">ToThunkFn</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">__THUNK__</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/utils/utils.ts#L2">src/types/utils/utils.ts:2</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/utils/utils.ts#L2">src/types/utils/utils.ts:2</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/ToThunkFn.html

@@ -25,7 +25,7 @@
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="TrlFn.html" class="tsd-signature-type tsd-kind-type-alias">TrlFn</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/utils/utils.ts#L1">src/types/utils/utils.ts:1</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/utils/utils.ts#L1">src/types/utils/utils.ts:1</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/TopologicalStatus.html

@@ -17,7 +17,7 @@
 <h1>Type alias TopologicalStatus</h1></div>
 <div class="tsd-signature"><span class="tsd-kind-type-alias">Topological<wbr/>Status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/directed-graph.ts#L2">src/types/data-structures/directed-graph.ts:2</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/directed-graph.ts#L2">src/types/data-structures/directed-graph.ts:2</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/TreeMultisetNodeNested.html

@@ -22,7 +22,7 @@
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/tree-multiset.ts#L4">src/types/data-structures/tree-multiset.ts:4</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/tree-multiset.ts#L4">src/types/data-structures/tree-multiset.ts:4</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/TreeMultisetOptions.html

@@ -20,7 +20,7 @@
 <h4>Type declaration</h4>
 <ul class="tsd-parameters"></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/tree-multiset.ts#L6">src/types/data-structures/tree-multiset.ts:6</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/tree-multiset.ts#L6">src/types/data-structures/tree-multiset.ts:6</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/TrlAsyncFn.html

@@ -30,7 +30,7 @@
 <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/utils/utils.ts#L4">src/types/utils/utils.ts:4</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/utils/utils.ts#L4">src/types/utils/utils.ts:4</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/TrlFn.html

@@ -30,7 +30,7 @@
 <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/utils/utils.ts#L3">src/types/utils/utils.ts:3</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/utils/utils.ts#L3">src/types/utils/utils.ts:3</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/Turning.html

@@ -17,7 +17,7 @@
 <h1>Type alias Turning</h1></div>
 <div class="tsd-signature"><span class="tsd-kind-type-alias">Turning</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/><span>    </span><span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">key</span><span class="tsd-signature-symbol"> in </span><a href="Direction.html" class="tsd-signature-type tsd-kind-type-alias">Direction</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><a href="Direction.html" class="tsd-signature-type tsd-kind-type-alias">Direction</a><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/navigator.ts#L2">src/types/data-structures/navigator.ts:2</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/navigator.ts#L2">src/types/data-structures/navigator.ts:2</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/types/VertexId.html

@@ -17,7 +17,7 @@
 <h1>Type alias VertexId</h1></div>
 <div class="tsd-signature"><span class="tsd-kind-type-alias">Vertex<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/types/data-structures/abstract-graph.ts#L1">src/types/data-structures/abstract-graph.ts:1</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/types/data-structures/abstract-graph.ts#L1">src/types/data-structures/abstract-graph.ts:1</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/variables/THUNK_SYMBOL.html

@@ -17,7 +17,7 @@
 <h1>Variable THUNK_SYMBOL<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
 <div class="tsd-signature"><span class="tsd-kind-variable">THUNK_<wbr/>SYMBOL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="THUNK_SYMBOL.html" class="tsd-signature-type tsd-kind-variable">THUNK_SYMBOL</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/83d3f8d/src/utils/utils.ts#L35">src/utils/utils.ts:35</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/zrwusa/data-structure-typed/blob/6996813/src/utils/utils.ts#L35">src/utils/utils.ts:35</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/jest.config.js

@@ -1,5 +1,7 @@
 module.exports = {
-    preset: 'ts-jest',
-    testEnvironment: 'node',
-    testMatch: ['<rootDir>/test/**/*.test.ts', '<rootDir>/test/**/*.test.js'],
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/test/**/*.test.ts', '<rootDir>/test/**/*.test.js'],
+  collectCoverage: true,
+  coverageDirectory: 'coverage'
 };

package/lib/data-structures/binary-tree/abstract-binary-tree.d.ts

@@ -201,9 +201,45 @@ export declare abstract class AbstractBinaryTree<N extends AbstractBinaryTreeNod
      * @returns The function `getPathToRoot` returns an array of nodes (`N[]`).
      */
     getPathToRoot(node: N, isReverse?: boolean): N[];
+    /**
+     * The function `getLeftMost` returns the leftmost node in a binary tree, starting from a specified node or the root if
+     * no node is specified.
+     * generic type representing a node in a binary tree), `BinaryTreeNodeId` (a type representing the ID of a binary tree
+     * node), or `null`.
+     * @returns The function `getLeftMost` returns the leftmost node in a binary tree. If the `beginRoot` parameter is
+     * provided, it starts the traversal from that node. If `beginRoot` is not provided or is `null`, it starts the traversal
+     * from the root of the binary tree. The function returns the leftmost node found during the traversal. If no leftmost
+     * node is found (
+     */
     getLeftMost(): N | null;
+    /**
+     * The function `getLeftMost` returns the leftmost node in a binary tree, starting from a specified node or the root if
+     * no node is specified.
+     * @param {N | BinaryTreeNodeId | null} [node] - The `beginRoot` parameter is optional and can be of type `N` (a
+     * generic type representing a node in a binary tree), `BinaryTreeNodeId` (a type representing the ID of a binary tree
+     * node).
+     * @returns The function `getLeftMost` returns the leftmost node in a binary tree. If the `beginRoot` parameter is
+     * provided, it starts the traversal from that node. If `beginRoot` is not provided or is `null`, it starts the traversal
+     * from the root of the binary tree. The function returns the leftmost node found during the traversal. If no leftmost
+     * node is found (
+     */
     getLeftMost(node: N): N;
+    /**
+     * The `getRightMost` function returns the rightmost node in a binary tree, either recursively or iteratively using tail
+     * recursion optimization.
+     * @returns The `getRightMost` function returns the rightmost node in a binary tree. It returns the
+     * rightmost node starting from the root of the binary tree.
+     */
     getRightMost(): N | null;
+    /**
+     * The `getRightMost` function returns the rightmost node in a binary tree, either recursively or iteratively using tail
+     * recursion optimization.
+     * @param {N | null} [node] - The `node` parameter is an optional parameter of type `N` or `null`. It represents the
+     * starting node from which we want to find the rightmost node. If no node is provided, the function will default to
+     * using the root node of the data structure.
+     * @returns The `getRightMost` function returns the rightmost node in a binary tree. It returns the rightmost node
+     * starting from that node.
+     */
     getRightMost(node: N): N;
     /**
      * The function checks if a binary search tree is valid by traversing it either recursively or iteratively.
@@ -244,25 +280,134 @@ export declare abstract class AbstractBinaryTree<N extends AbstractBinaryTreeNod
      * @returns a boolean value.
      */
     subTreeAdd(subTreeRoot: N | BinaryTreeNodeId | null, delta: number, propertyName?: BinaryTreeNodePropertyName): boolean;
+    /**
+     * Performs a breadth-first search (BFS) on a binary tree, accumulating properties of each node based on their 'id' property.
+     * @returns An array of binary tree node IDs.
+     */
     BFS(): BinaryTreeNodeId[];
+    /**
+     * Performs a breadth-first search (BFS) on a binary tree, accumulating properties of each node based on the specified property name.
+     * @param {'id'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of values corresponding to the specified property.
+     */
     BFS(nodeOrPropertyName: 'id'): BinaryTreeNodeId[];
+    /**
+     * Performs a breadth-first search (BFS) on a binary tree, accumulating the 'val' property of each node.
+     * @param {'val'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of 'val' properties from each node.
+     */
     BFS(nodeOrPropertyName: 'val'): N['val'][];
+    /**
+     * Performs a breadth-first search (BFS) on a binary tree, accumulating nodes themselves.
+     * @param {'node'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of binary tree nodes.
+     */
     BFS(nodeOrPropertyName: 'node'): N[];
+    /**
+     * Performs a depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on their 'id' property.
+     * @returns An array of binary tree node IDs.
+     */
     DFS(): BinaryTreeNodeId[];
+    /**
+     * Performs a depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on the specified property name.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {string} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of values corresponding to the specified property.
+     */
     DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
+    /**
+     * Performs a depth-first search (DFS) traversal on a binary tree and accumulates the 'val' property of each node.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {'val'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of 'val' properties from each node.
+     */
     DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): N[];
+    /**
+     * Performs a depth-first search (DFS) traversal on a binary tree and accumulates nodes themselves.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {'node'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of binary tree nodes.
+     */
     DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): N[];
+    /**
+     * Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on their 'id' property.
+     * @returns An array of binary tree node IDs.
+     */
     DFSIterative(): BinaryTreeNodeId[];
+    /**
+     * Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates properties of each node based on the specified property name.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {string} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of values corresponding to the specified property.
+     */
     DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
+    /**
+     * Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates the 'val' property of each node.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {'val'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of 'val' properties from each node.
+     */
     DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): N[];
+    /**
+     * Performs an iterative depth-first search (DFS) traversal on a binary tree and accumulates nodes themselves.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {'node'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of binary tree nodes.
+     */
     DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): N[];
+    /**
+     * Performs a level-order traversal on a binary tree starting from the specified node and accumulates properties of each node based on their 'id' property.
+     * @param {N | null} node - The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
+     * @returns An array of binary tree node IDs.
+     */
     levelIterative(node: N | null): BinaryTreeNodeId[];
+    /**
+     * Performs a level-order traversal on a binary tree starting from the specified node and accumulates properties of each node based on the specified property name.
+     * @param {N | null} node - The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
+     * @param {string} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of values corresponding to the specified property.
+     */
     levelIterative(node: N | null, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
+    /**
+     * Performs a level-order traversal on a binary tree starting from the specified node and accumulates the 'val' property of each node.
+     * @param {N | null} node - The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
+     * @param {'val'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of 'val' properties from each node.
+     */
     levelIterative(node: N | null, nodeOrPropertyName?: 'val'): N['val'][];
+    /**
+     * Performs a level-order traversal on a binary tree starting from the specified node and accumulates nodes themselves.
+     * @param {N | null} node - The starting node for the level order traversal. If null, the root node of the tree is used as the starting node.
+     * @param {'node'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of binary tree nodes.
+     */
     levelIterative(node: N | null, nodeOrPropertyName?: 'node'): N[];
+    /**
+     * Collects nodes from a binary tree by a specified property and organizes them into levels.
+     * @param {N | null} node - The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
+     * @returns A 2D array of AbstractBinaryTreeNodeProperty<N> objects.
+     */
     listLevels(node: N | null): BinaryTreeNodeId[][];
+    /**
+     * Collects nodes from a binary tree by a specified property and organizes them into levels.
+     * @param {N | null} node - The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
+     * @param {'id} nodeOrPropertyName - The property of the BinaryTreeNode object to collect at each level.
+     * @returns A 2D array of values corresponding to the specified property.
+     */
     listLevels(node: N | null, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[][];
+    /**
+     * Collects nodes from a binary tree by a specified property and organizes them into levels.
+     * @param {N | null} node - The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
+     * @param {'val'} nodeOrPropertyName - The property of the BinaryTreeNode object to collect at each level.
+     * @returns A 2D array of 'val' properties from each node.
+     */
     listLevels(node: N | null, nodeOrPropertyName?: 'val'): N['val'][][];
+    /**
+     * Collects nodes from a binary tree by a specified property and organizes them into levels.
+     * @param {N | null} node - The root node of the binary tree or null. If null, the function will use the root node of the current binary tree instance.
+     * @param {'node'} nodeOrPropertyName - The property of the BinaryTreeNode object to collect at each level.
+     * @returns A 2D array of binary tree nodes.
+     */
     listLevels(node: N | null, nodeOrPropertyName?: 'node'): N[][];
     /**
      * The function returns the predecessor of a given node in a binary tree.
@@ -270,12 +415,34 @@ export declare abstract class AbstractBinaryTree<N extends AbstractBinaryTreeNod
      * @returns the predecessor of the given node in a binary tree.
      */
     getPredecessor(node: N): N;
+    /**
+     * Time complexity is O(n)
+     * Space complexity of Iterative DFS equals to recursive DFS which is O(n) because of the stack
+     */
+    /**
+     * Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm.
+     * @returns An array of binary tree node IDs.
+     */
     morris(): BinaryTreeNodeId[];
+    /**
+     * Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm and accumulates properties of each node based on the specified property name.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {'id'} nodeOrPropertyName - The name of the property to accumulate.
+     * @returns An array of values corresponding to the specified property.
+     */
     morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
+    /**
+     * Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm and accumulates the 'val' property of each node.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {'val'} nodeOrPropertyName - The property of the BinaryTreeNode object to collect at each level.
+     * @returns An array of 'val' properties from each node.
+     */
     morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): N[];
     /**
-     * Time complexity is O(n)
-     * Space complexity of Iterative DFS equals to recursive DFS which is O(n) because of the stack
+     * Performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm and accumulates nodes themselves.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {'node'} nodeOrPropertyName - The property of the BinaryTreeNode object to collect at each level.
+     * @returns An array of binary tree nodes.
      */
     morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): N[];
     /**

package/lib/data-structures/binary-tree/abstract-binary-tree.js

@@ -557,14 +557,15 @@ export class AbstractBinaryTree {
         return isReverse ? result.reverse() : result;
     }
     /**
-     * The `getLeftMost` function returns the leftmost node in a binary tree, starting from a specified node or the root if
+     * The function `getLeftMost` returns the leftmost node in a binary tree, starting from a specified node or the root if
      * no node is specified.
      * @param {N | BinaryTreeNodeId | null} [beginRoot] - The `beginRoot` parameter is optional and can be of type `N` (a
      * generic type representing a node in a binary tree), `BinaryTreeNodeId` (a type representing the ID of a binary tree
      * node), or `null`.
      * @returns The function `getLeftMost` returns the leftmost node in a binary tree. If the `beginRoot` parameter is
-     * provided, it starts the traversal from that node. If `beginRoot` is not provided or is `null`, it starts the
-     * traversal from the root of the binary tree. If there are no nodes in the binary tree, it returns `null`.
+     * provided, it starts the traversal from that node. If `beginRoot` is not provided or is `null`, it starts the traversal
+     * from the root of the binary tree. The function returns the leftmost node found during the traversal. If no leftmost
+     * node is found (
      */
     getLeftMost(beginRoot) {
         if (typeof beginRoot === 'number')
@@ -591,14 +592,14 @@ export class AbstractBinaryTree {
         }
     }
     /**
-     * The `getRightMost` function returns the rightmost node in a binary tree, either recursively or iteratively using
-     * tail recursion optimization.
+     * The `getRightMost` function returns the rightmost node in a binary tree, either recursively or iteratively using tail
+     * recursion optimization.
      * @param {N | null} [node] - The `node` parameter is an optional parameter of type `N` or `null`. It represents the
-     * starting node from which we want to find the rightmost node. If no node is provided, the `node` parameter defaults
-     * to `this.root`, which is the root node of the data structure
-     * @returns The function `getRightMost` returns the rightmost node (`N`) in a binary tree. If the `node` parameter is
-     * not provided, it defaults to the root node of the tree. If the tree is empty or the `node` parameter is `null`, the
-     * function returns `null`.
+     * starting node from which we want to find the rightmost node. If no node is provided, the function will default to
+     * using the root node of the data structure.
+     * @returns The `getRightMost` function returns the rightmost node in a binary tree. If the `node` parameter is provided,
+     * it returns the rightmost node starting from that node. If the `node` parameter is not provided, it returns the
+     * rightmost node starting from the root of the binary tree.
      */
     getRightMost(node) {
         // TODO support get right most by passing id in
@@ -793,13 +794,11 @@ export class AbstractBinaryTree {
         return true;
     }
     /**
-     * The BFS function performs a breadth-first search on a binary tree, accumulating properties of each node based on a
-     * specified property name.
-     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` is an optional parameter that
-     * represents either a node or a property name. If a node is provided, the breadth-first search (BFS) algorithm will be
-     * performed starting from that node. If a property name is provided, the BFS algorithm will be performed starting from
-     * the
-     * @returns an instance of the `AbstractBinaryTreeNodeProperties` class with generic type `N`.
+     * The BFS function performs a breadth-first search on a binary tree, accumulating properties of each node based on a specified property name.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - An optional parameter that represents either a node or a property name.
+     * If a node is provided, the BFS algorithm will be performed starting from that node.
+     * If a property name is provided, the BFS algorithm will be performed starting from the root node, accumulating the specified property.
+     * @returns An instance of the `AbstractBinaryTreeNodeProperties` class with generic type `N`.
      */
     BFS(nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName !== null && nodeOrPropertyName !== void 0 ? nodeOrPropertyName : 'id';
@@ -820,13 +819,9 @@ export class AbstractBinaryTree {
     /**
      * The DFS function performs a depth-first search traversal on a binary tree and returns the accumulated properties of
      * each node based on the specified pattern and property name.
-     * @param {'in' | 'pre' | 'post'} [pattern] - The "pattern" parameter is used to specify the traversal order of the
-     * binary tree. It can have three possible values:
-     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is a string that represents
-     * the name of a property of the nodes in the binary tree. This property will be used to accumulate values during the
-     * depth-first search traversal. If no `nodeOrPropertyName` is provided, the default value is `'id'`.
-     * @returns an instance of the AbstractBinaryTreeNodeProperties class, which contains the accumulated properties of the
-     * binary tree nodes based on the specified pattern and node or property name.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The name of a property of the nodes in the binary tree. This property will be used to accumulate values during the depth-first search traversal. If no `nodeOrPropertyName` is provided, the default value is `'id'`.
+     * @returns an instance of the AbstractBinaryTreeNodeProperties class, which contains the accumulated properties of the binary tree nodes based on the specified pattern and node or property name.
      */
     DFS(pattern, nodeOrPropertyName) {
         pattern = pattern !== null && pattern !== void 0 ? pattern : 'in';
@@ -863,13 +858,9 @@ export class AbstractBinaryTree {
     /**
      * The DFSIterative function performs an iterative depth-first search traversal on a binary tree, with the option to
      * specify the traversal pattern and the property name to accumulate results by.
-     * @param {'in' | 'pre' | 'post'} [pattern] - The "pattern" parameter determines the order in which the nodes of the
-     * binary tree are visited during the depth-first search. It can have one of the following values:
-     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is used to specify the
-     * property of the nodes that you want to retrieve or perform operations on during the depth-first search traversal. By
-     * default, it is set to `'id'`, which means that the traversal will accumulate results based on the `id` property of
-     * the
-     * @returns an object of type AbstractBinaryTreeNodeProperties<N>.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The name of a property of the nodes in the binary tree. This property will be used to accumulate values during the depth-first search traversal. By default, it is set to `'id'`.
+     * @returns An object of type AbstractBinaryTreeNodeProperties<N>.
      */
     DFSIterative(pattern, nodeOrPropertyName) {
         pattern = pattern || 'in';
@@ -922,8 +913,8 @@ export class AbstractBinaryTree {
      * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that
      * can be either a `BinaryTreeNode` property name or the string `'id'`. If a property name is provided, the function
      * will accumulate results based on that property. If no property name is provided, the function will default to
-     * accumulating results
-     * @returns The function `levelIterative` returns an object of type `AbstractBinaryTreeNodeProperties<N>`.
+     * accumulating results based on the 'id' property.
+     * @returns An object of type `AbstractBinaryTreeNodeProperties<N>`.
      */
     levelIterative(node, nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName || 'id';
@@ -948,12 +939,9 @@ export class AbstractBinaryTree {
     }
     /**
      * The `listLevels` function collects nodes from a binary tree by a specified property and organizes them into levels.
-     * @param {N | null} node - The `node` parameter is a BinaryTreeNode object or null. It represents the
-     * root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance.
-     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that
-     * specifies the property of the `BinaryTreeNode` object to collect at each level. It can be one of the following
-     * values:
-     * @returns The function `listLevels` returns a 2D array of `AbstractBinaryTreeNodeProperty<N>` objects.
+     * @param {N | null} node - The `node` parameter is a BinaryTreeNode object or null. It represents the root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that specifies the property of the `BinaryTreeNode` object to collect at each level. It can be one of the following values: 'id', 'val', or 'node'. If not provided, it defaults to 'id'.
+     * @returns A 2D array of `AbstractBinaryTreeNodeProperty<N>` objects.
      */
     listLevels(node, nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName || 'id';
@@ -1025,14 +1013,10 @@ export class AbstractBinaryTree {
         }
     }
     /**
-     * The `morris` function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris
-     * traversal algorithm.
-     * @param {'in' | 'pre' | 'post'} [pattern] - The `pattern` parameter determines the traversal pattern for the binary
-     * tree. It can have one of three values:
-     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is used to specify the
-     * property name of the nodes that you want to retrieve. It can be any valid property name of the nodes in the binary
-     * tree.
-     * @returns an array of AbstractBinaryTreeNodeProperties<N> objects.
+     * The `morris` function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The property name of the nodes to retrieve or perform operations on during the traversal. It can be any valid property name of the nodes in the binary tree. If not provided, it defaults to 'id'.
+     * @returns An array of AbstractBinaryTreeNodeProperties<N> objects.
      */
     morris(pattern, nodeOrPropertyName) {
         if (this.root === null)