data-structure-typed 1.12.21 → 1.15.0

package/dist/data-structures/linked-list/singly-linked-list.js

@@ -71,63 +71,71 @@ var __values = (this && this.__values) || function(o) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SinglyLinkedList = exports.SinglyLinkedListNode = void 0;
-/**
- * The class which represents one link or node in a linked list
- * ```ts
- * const node = new SinglyLinkedListNode(1, null, null, null);
- * ```
- */
+/* The SinglyLinkedListNode class represents a node in a singly linked list and provides methods for inserting, removing,
+and accessing nodes. */
 var SinglyLinkedListNode = /** @class */ (function () {
-    function SinglyLinkedListNode(
-    /** Data stored on the node */
-    val, 
-    /** The previous node in the list */
-    prev, 
-    /** The next link in the list */
-    next, 
-    /** The list this node belongs to */
-    list) {
-        this.val = val;
-        this.prev = prev;
-        this.next = next;
-        this.list = list;
+    function SinglyLinkedListNode(val, prev, next, list) {
+        this._val = val;
+        this._prev = prev || null;
+        this._next = next || null;
+        this._list = list || null;
     }
-    Object.defineProperty(SinglyLinkedListNode.prototype, "value", {
-        /**
-         * Alias to .val
-         * ```ts
-         * new LinkedList(1, 2, 3).head.value; // 1
-         * ```
-         */
+    Object.defineProperty(SinglyLinkedListNode.prototype, "val", {
+        get: function () {
+            return this._val;
+        },
+        set: function (value) {
+            this._val = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SinglyLinkedListNode.prototype, "prev", {
         get: function () {
-            return this.val;
+            return this._prev;
+        },
+        set: function (value) {
+            this._prev = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SinglyLinkedListNode.prototype, "next", {
+        get: function () {
+            return this._next;
+        },
+        set: function (value) {
+            this._next = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SinglyLinkedListNode.prototype, "list", {
+        get: function () {
+            return this._list;
+        },
+        set: function (value) {
+            this._list = value;
         },
         enumerable: false,
         configurable: true
     });
     Object.defineProperty(SinglyLinkedListNode.prototype, "index", {
-        /**
-         * Get the index of this node
-         * ```ts
-         * new LinkedList(1, 2, 3).head.index; // 0
-         * ```
-         */
         get: function () {
             var _this = this;
             if (!this.list) {
                 return undefined;
             }
-            return this.list.findIndex(function (value) { return value === _this.value; });
+            return this.list.findIndex(function (value) { return value === _this.val; });
         },
         enumerable: false,
         configurable: true
     });
     /**
-     * Insert a new node before this one
-     * ```ts
-     * new LinkedList(2, 3).head.insertBefore(1); // 1 <=> 2 <=> 3
-     * ```
-     * @param val Data to save in the node
+     * The `insertBefore` function inserts a new node with the given value before the current node in a singly linked list.
+     * @param {NodeVal} val - The parameter "val" is of type "NodeVal". It represents the value of the node that you want
+     * to insert before the current node.
+     * @returns The method is returning a SinglyLinkedList<NodeVal>.
      */
     SinglyLinkedListNode.prototype.insertBefore = function (val) {
         return this.list !== null
@@ -135,11 +143,9 @@ var SinglyLinkedListNode = /** @class */ (function () {
             : new SinglyLinkedList(val, this.val);
     };
     /**
-     * Insert new val after this node
-     * ```ts
-     * new LinkedList(1, 2).tail.insertAfter(3); // 1 <=> 2 <=> 3
-     * ```
-     * @param val Data to be saved in the node
+     * The function inserts a new node with the given value after the current node in a singly linked list.
+     * @param {NodeVal} val - The parameter `val` is the value of the node that you want to insert after the current node.
+     * @returns The method is returning a SinglyLinkedList<NodeVal>.
      */
     SinglyLinkedListNode.prototype.insertAfter = function (val) {
         return this.list !== null
@@ -147,10 +153,8 @@ var SinglyLinkedListNode = /** @class */ (function () {
             : new SinglyLinkedList(this.val, val);
     };
     /**
-     * Remove this node
-     * ```ts
-     * new LinkedList(1, 2, 3, 4).tail.remove(); // 1 <=> 2 <=> 3
-     * ```
+     * The `remove()` function removes a node from a singly linked list.
+     * @returns The remove() method is returning a SinglyLinkedListNode<NodeVal> object.
      */
     SinglyLinkedListNode.prototype.remove = function () {
         if (this.list === null) {
@@ -161,71 +165,86 @@ var SinglyLinkedListNode = /** @class */ (function () {
     return SinglyLinkedListNode;
 }());
 exports.SinglyLinkedListNode = SinglyLinkedListNode;
-/**
- * A doubly linked list
- * ```ts
- * const list = new LinkedList(1, 2, 3);
- * const listFromArray = LinkedList.from([1, 2, 3]);
- * ```
- */
 var SinglyLinkedList = /** @class */ (function () {
+    /**
+     * The constructor initializes a linked list with the given arguments as nodes.
+     * @param {NodeVal[]} args - args is a rest parameter that allows the constructor to accept an arbitrary number of
+     * arguments of type NodeVal.
+     */
     function SinglyLinkedList() {
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
             args[_i] = arguments[_i];
         }
-        this.head = null;
-        this.tail = null;
-        this.size = 0;
+        this._head = null;
+        this._tail = null;
+        this._size = 0;
         for (var i = 0; i < arguments.length; i++) {
             this.append(args[i]);
         }
     }
-    Object.defineProperty(SinglyLinkedList.prototype, "length", {
-        /**
-         * The length of the list
-         */
+    Object.defineProperty(SinglyLinkedList.prototype, "head", {
+        get: function () {
+            return this._head;
+        },
+        set: function (value) {
+            this._head = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SinglyLinkedList.prototype, "tail", {
         get: function () {
-            return this.size;
+            return this._tail;
+        },
+        set: function (value) {
+            this._tail = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SinglyLinkedList.prototype, "size", {
+        get: function () {
+            return this._size;
+        },
+        set: function (value) {
+            this._size = value;
         },
         enumerable: false,
         configurable: true
     });
     /**
-     * Convert any iterable to a new linked list
-     * ```javascript
-     * const array = [1, 2, 3];
-     * const list = LinkedList.from(array);
-     * ```
-     * @param iterable Any iterable datatype like Array or Map
+     * The `from` function in TypeScript creates a new SinglyLinkedList instance from an iterable object.
+     * @param iterable - The `iterable` parameter is an object that can be iterated over, such as an array or a string. It
+     * contains a collection of elements of type `T`.
+     * @returns The method is returning a new instance of the SinglyLinkedList class.
      */
     SinglyLinkedList.from = function (iterable) {
         return new (SinglyLinkedList.bind.apply(SinglyLinkedList, __spreadArray([void 0], __read(iterable), false)))();
     };
     /**
-     * Get the node val at a specified index, zero based
-     * ```ts
-     * new LinkedList(1, 2, 3).get(0); // 1
-     * ```
-     * @param index to retrieve val at
+     * The `get` function returns the value of a node at a given index in a data structure.
+     * @param {number} index - The index parameter is a number that represents the position of the node in the data
+     * structure.
+     * @returns The method is returning the value of the node at the specified index if the node exists, otherwise it
+     * returns undefined.
      */
     SinglyLinkedList.prototype.get = function (index) {
         var node = this.getNode(index);
         return node !== undefined ? node.val : undefined;
     };
     /**
-     * Get the node at index, zero based
-     * ```ts
-     * new LinkedList(1, 2, 3).getNode(0);
-     * // { prev: null, val: 1, next: SinglyLinkedListNode }
-     * ```
+     * The function `getNode` returns the node at a given index in a singly linked list.
+     * @param {number} index - The `index` parameter is a number that represents the position of the node we want to
+     * retrieve from the linked list.
+     * @returns a SinglyLinkedListNode<NodeVal> object or undefined.
      */
     SinglyLinkedList.prototype.getNode = function (index) {
-        if (this.head === null || index < 0 || index >= this.length) {
+        if (this.head === null || index < 0 || index >= this.size) {
             return undefined;
         }
-        var asc = index < this.length / 2;
-        var stopAt = asc ? index : this.length - index - 1;
+        var asc = index < this.size / 2;
+        var stopAt = asc ? index : this.size - index - 1;
         var nextNode = asc ? 'next' : 'prev';
         var currentNode = asc ? this.head : this.tail;
         // TODO after no-non-null-assertion not ensure the logic
@@ -237,19 +256,21 @@ var SinglyLinkedList = /** @class */ (function () {
         return currentNode || undefined;
     };
     /**
-     * Return the first node and its index in the list that
-     * satisfies the testing function
-     * ```ts
-     * new LinkedList(1, 2, 3).findNodeIndex(val => val === 1);
-     * // { node: SinglyLinkedListNode, index: 0 }
-     * ```
-     * @param f A function to be applied to the val of each node
+     * The function `findNodeIndex` searches for a node in a singly linked list that satisfies a given condition and
+     * returns its index and the node itself.
+     * @param callbackFn - The callbackFn parameter is a function that takes three arguments: data, index, and list. It is
+     * used to determine whether a node in the singly linked list matches a certain condition. The function should return a
+     * boolean value indicating whether the condition is met for the given node.
+     * @returns The function `findNodeIndex` returns an object with two properties: `node` and `index`. The `node` property
+     * contains the node that matches the condition specified in the `callbackFn` function, and the `index` property
+     * contains the index of that node in the linked list. If no node matches the condition, the function returns
+     * `undefined`.
      */
-    SinglyLinkedList.prototype.findNodeIndex = function (f) {
+    SinglyLinkedList.prototype.findNodeIndex = function (callbackFn) {
         var currentIndex = 0;
         var currentNode = this.head;
         while (currentNode) {
-            if (f(currentNode.val, currentIndex, this)) {
+            if (callbackFn(currentNode.val, currentIndex, this)) {
                 return {
                     index: currentIndex,
                     node: currentNode,
@@ -261,51 +282,40 @@ var SinglyLinkedList = /** @class */ (function () {
         return undefined;
     };
     /**
-     * Returns the first node in the list that
-     * satisfies the provided testing function. Otherwise undefined is returned.
-     * ```ts
-     * new LinkedList(1, 2, 3).findNode(val => val === 1);
-     * // { prev: null, val: 1, next: SinglyLinkedListNode }
-     * ```
-     * @param f Function to test val against
+     * The findNode function searches for a node in a singly linked list based on a given callback function.
+     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It returns a boolean
+     * value indicating whether the current node matches the desired criteria.
+     * @returns The function `findNode` returns a `SinglyLinkedListNode<NodeVal>` if a node satisfying the condition
+     * specified by the `callbackFn` is found in the linked list. If no such node is found, it returns `undefined`.
      */
-    SinglyLinkedList.prototype.findNode = function (f) {
-        var nodeIndex = this.findNodeIndex(f);
+    SinglyLinkedList.prototype.findNode = function (callbackFn) {
+        var nodeIndex = this.findNodeIndex(callbackFn);
         return nodeIndex !== undefined ? nodeIndex.node : undefined;
     };
     /**
-     * Returns the value of the first element in the list that
-     * satisfies the provided testing function. Otherwise undefined is returned.
-     * ```ts
-     * new LinkedList(1, 2, 3).find(val => val === 1); // 1
-     * ```
-     * @param f Function to test val against
+     * The `find` function in TypeScript searches for a node in a singly linked list based on a given callback function and
+     * returns the value of the found node.
+     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It returns a boolean
+     * value indicating whether the condition is met for a particular node in the linked list.
+     * @returns The method `find` returns the `NodeVal` value of the first node in the linked list that satisfies the
+     * condition specified by the `callbackFn` function. If no node satisfies the condition, it returns `undefined`.
      */
-    SinglyLinkedList.prototype.find = function (f) {
-        var nodeIndex = this.findNodeIndex(f);
+    SinglyLinkedList.prototype.find = function (callbackFn) {
+        var nodeIndex = this.findNodeIndex(callbackFn);
         return nodeIndex !== undefined ? nodeIndex.node.val : undefined;
     };
     /**
-     * Returns the index of the first node in the list that
-     * satisfies the provided testing function. Ohterwise -1 is returned.
-     * ```ts
-     * new LinkedList(1, 2, 3).findIndex(val => val === 3); // 2
-     * ```
-     * @param f Function to test val against
+     * The findIndex function returns the index of the first node in a singly linked list that satisfies a given condition,
+     * or -1 if no such node is found.
+     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It returns a boolean
+     * value indicating whether the condition is met for a particular node in the singly linked list.
+     * @returns The method `findIndex` returns a number.
      */
-    SinglyLinkedList.prototype.findIndex = function (f) {
-        var nodeIndex = this.findNodeIndex(f);
+    SinglyLinkedList.prototype.findIndex = function (callbackFn) {
+        var nodeIndex = this.findNodeIndex(callbackFn);
         return nodeIndex !== undefined ? nodeIndex.index : -1;
     };
-    /**
-     * Append one or any number of nodes to the end of the list.
-     * This modifies the list in place and returns the list itself
-     * to make this method chainable.
-     * ```ts
-     * new LinkedList(1).append(2).append(3, 4); // 1 <=> 2 <=> 3 <=> 4
-     * ```
-     * @param args Data to be stored in the node, takes any number of arguments
-     */
+    /* The above code is a comment in TypeScript. It is using the triple hash symbol ( */
     SinglyLinkedList.prototype.append = function () {
         var e_1, _a;
         var args = [];
@@ -336,11 +346,11 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * Synonym for append
-     * ```ts
-     * new LinkedList(1).push(2).push(3, 4); // 1 <=> 2 <=> 3 <=> 4
-     * ```
-     * @param args Data to be stored, takes any number of arguments
+     * The push function appends multiple NodeVal objects to a data structure and returns the new size of the data
+     * structure.
+     * @param {NodeVal[]} args - args is a rest parameter of type NodeVal[]. It allows the function to accept any number
+     * of arguments of type NodeVal.
+     * @returns The size of the data structure after the nodes are appended.
      */
     SinglyLinkedList.prototype.push = function () {
         var args = [];
@@ -348,15 +358,12 @@ var SinglyLinkedList = /** @class */ (function () {
             args[_i] = arguments[_i];
         }
         this.append.apply(this, __spreadArray([], __read(args), false));
-        return this.length;
+        return this.size;
     };
     /**
-     * Prepend any number of val arguments to the list. The
-     * argument list is prepended as a block to reduce confusion:
-     * ```javascript
-     * new LinkedList(3, 4).prepend(0, 1, 2); // [0, 1, 2, 3, 4]
-     * ```
-     * @param args Data to be stored in the node, accepts any number of arguments
+     * The `prepend` function adds new nodes to the beginning of a singly linked list.
+     * @param {NodeVal[]} args - An array of NodeVal objects.
+     * @returns The `prepend` method is returning the updated `SinglyLinkedList` object.
      */
     SinglyLinkedList.prototype.prepend = function () {
         var e_2, _a;
@@ -389,14 +396,12 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * Insert a new node at a given index position. If index is
-     * out of bounds, the node is appended, if index is negative
-     * or 0, it will be prepended.
-     * ```ts
-     * new LinkedList(1, 3).insertAt(1, 2); // 1 <=> 2 <=> 3
-     * ```
-     * @param index The index to insert the new node at
-     * @param val Data to be stored on the new node
+     * The `insertAt` function inserts a value at a specified index in a singly linked list.
+     * @param {number} index - The index parameter is a number that represents the position at which the new node should be
+     * inserted in the linked list.
+     * @param {NodeVal} val - The `val` parameter represents the value of the node that you want to insert into the linked
+     * list.
+     * @returns The method `insertAt` returns the updated `SinglyLinkedList` object.
      */
     SinglyLinkedList.prototype.insertAt = function (index, val) {
         if (this.head === null) {
@@ -415,13 +420,11 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * Remove the specified node from the list and return the removed
-     * node afterwards.
-     * ```ts
-     * const list = new LinkedList(1, 2, 3);
-     * list.removeNode(list.tail); // { prev: null, val: 3, next: null, list: null }
-     * ```
-     * @param node The node to be removed
+     * The removeNode function removes a node from a singly linked list and updates the head, tail, and size properties
+     * accordingly.
+     * @param node - The `node` parameter is of type `SinglyLinkedListNode<NodeVal>`, which represents a node in a singly
+     * linked list.
+     * @returns the removed node.
      */
     SinglyLinkedList.prototype.removeNode = function (node) {
         if (node.list !== this) {
@@ -446,24 +449,23 @@ var SinglyLinkedList = /** @class */ (function () {
         return node;
     };
     /**
-     * Remove the node at the specified index
-     * ```ts
-     * new LinkedList(1, 2, 3).removeAt(2); // { prev: null, val: 3, next: null, list: null }
-     * ```
-     * @param index Index at which to remove
+     * The `removeAt` function removes a node at a specified index from a singly linked list.
+     * @param {number} index - The index parameter is a number that represents the position of the node to be removed in
+     * the singly linked list.
+     * @returns The method `removeAt` returns a `SinglyLinkedListNode<NodeVal>` if the node at the specified index is
+     * found and removed successfully. If the node is not found, it returns `undefined`.
      */
     SinglyLinkedList.prototype.removeAt = function (index) {
         var node = this.getNode(index);
         return node !== undefined ? this.removeNode(node) : undefined;
     };
     /**
-     * Insert a new node before the reference node
-     * ```ts
-     * const list = new LinkedList(1, 3);
-     * list.insertBefore(list.tail, 2); // 1 <=> 2 <=> 3
-     * ```
-     * @param referenceNode The node reference
-     * @param val Data to save in the node
+     * The `insertBefore` function inserts a new node with a given value before a specified reference node in a singly
+     * linked list.
+     * @param referenceNode - The referenceNode parameter is the node in the linked list before which the new node will be
+     * inserted.
+     * @param {NodeVal} val - The value of the new node that will be inserted before the reference node.
+     * @returns The method is returning the updated SinglyLinkedList object.
      */
     SinglyLinkedList.prototype.insertBefore = function (referenceNode, val) {
         var node = new SinglyLinkedListNode(val, referenceNode.prev, referenceNode, this);
@@ -478,17 +480,18 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * Sorts the linked list using the provided compare function
-     * @param compare A function used to compare the val of two nodes. It should return
-     *                a boolean. True will insert a before b, false will insert b before a.
-     *                (a, b) => a < b or (1, 2) => 1 < 2 === true, 2 will be inserted after 1,
-     *                the sort order will be ascending.
+     * The `sort` function uses the quicksort algorithm to sort the elements of a singly linked list based on a provided
+     * comparison function.
+     * @param start - The `start` parameter is the starting node of the sublist that needs to be sorted.
+     * @param end - The `end` parameter is a reference to the last node in the linked list. It is used as the pivot element
+     * for the quicksort algorithm.
+     * @returns The `sort` method is returning the sorted `SinglyLinkedList` object.
      */
     SinglyLinkedList.prototype.sort = function (compare) {
         if (this.head === null || this.tail === null) {
             return this;
         }
-        if (this.length < 2) {
+        if (this.size < 2) {
             return this;
         }
         var quicksort = function (start, end) {
@@ -529,13 +532,11 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * Insert a new node after this one
-     * ```ts
-     * const list = new LinkedList(2, 3);
-     * list.insertAfter(list.head, 1); // 1 <=> 2 <=> 3
-     * ```
-     * @param referenceNode The reference node
-     * @param val Data to be saved in the node
+     * The `insertAfter` function inserts a new node with a given value after a specified reference node in a singly linked
+     * list.
+     * @param referenceNode - The referenceNode parameter is the node after which the new node will be inserted.
+     * @param {NodeVal} val - The value of the new node that will be inserted after the reference node.
+     * @returns The `insertAfter` method is returning the updated `SinglyLinkedList` object.
      */
     SinglyLinkedList.prototype.insertAfter = function (referenceNode, val) {
         var node = new SinglyLinkedListNode(val, referenceNode, referenceNode.next, this);
@@ -550,35 +551,23 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * Remove the first node from the list and return the val of the removed node
-     * or undefined
-     * ```ts
-     * new LinkedList(1, 2, 3).shift(); // 1
-     * ```
+     * The `shift()` function removes and returns the first element from a linked list.
+     * @returns The `shift()` method is returning a value of type `NodeVal` or `undefined`.
      */
     SinglyLinkedList.prototype.shift = function () {
         return this.removeFromAnyEnd(this.head);
     };
     /**
-     * Remove the last node from the list and return the val of the removed node
-     * or undefined if the list was empty
-     * ```ts
-     * new LinkedList(1, 2, 3).pop(); // 3
-     * ```
+     * The `pop()` function removes and returns the last element from a linked list.
+     * @returns The `pop()` method is returning a value of type `NodeVal` or `undefined`.
      */
     SinglyLinkedList.prototype.pop = function () {
         return this.removeFromAnyEnd(this.tail);
     };
     /**
-     * Merge the current list with another. Both lists will be
-     * equal after merging.
-     * ```ts
-     * const list = new LinkedList(1, 2);
-     * const otherList = new LinkedList(3);
-     * list.merge(otherList);
-     * (list === otherList); // true
-     * ```
-     * @param list The list to be merged
+     * The merge function merges two singly linked lists by updating the next and prev pointers, as well as the head, tail,
+     * and size properties.
+     * @param list - The parameter "list" is a SinglyLinkedList object that contains nodes with data of type NodeVal.
      */
     SinglyLinkedList.prototype.merge = function (list) {
         if (this.tail !== null) {
@@ -595,11 +584,8 @@ var SinglyLinkedList = /** @class */ (function () {
         list.tail = this.tail;
     };
     /**
-     * Removes all nodes from a list
-     *
-     * ```ts
-     * list.clear();
-     * ```
+     * The clear() function resets the linked list by setting the head and tail to null and the size to 0.
+     * @returns The "this" object is being returned.
      */
     SinglyLinkedList.prototype.clear = function () {
         this.head = null;
@@ -608,18 +594,15 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * The slice() method returns a shallow copy of a
-     * portion of a list into a new list object selected
-     * from start to end (end not included).
-     * The original list will not be modified.
-     * ```ts
-     * const list = new LinkedList(1, 2, 3, 4, 5);
-     * const newList = list.slice(0, 3); // 1 <=> 2 <=> 3
-     * ```
-     * @param start Start index
-     * @param end End index, optional
+     * The `slice` function returns a new SinglyLinkedList containing a portion of the original list, starting from the
+     * specified index and ending at the optional end index.
+     * @param {number} start - The `start` parameter is a number that represents the index at which to start slicing the
+     * linked list.
+     * @param {number} [end] - The `end` parameter is an optional number that specifies the index at which to end the
+     * slicing. If no value is provided for `end`, or if the provided value is less than the `start` index, the slicing
+     * will continue until the end of the list.
+     * @returns a new SinglyLinkedList containing the sliced elements from the original list.
      */
-    // eslint-disable-next-line @typescript-eslint/ban-types
     SinglyLinkedList.prototype.slice = function (start, end) {
         var list = new SinglyLinkedList();
         var finish = end;
@@ -627,7 +610,7 @@ var SinglyLinkedList = /** @class */ (function () {
             return list;
         }
         if (finish === undefined || finish < start) {
-            finish = this.length;
+            finish = this.size;
         }
         var head = this.getNode(start);
         for (var i = 0; i < finish - start && head !== null && head !== undefined; i++) {
@@ -637,11 +620,8 @@ var SinglyLinkedList = /** @class */ (function () {
         return list;
     };
     /**
-     * The reverse() function reverses the list in place and returns the list
-     * itself.
-     * ```ts
-     * new LinkedList(1, 2, 3).reverse(); // 3 <=> 2 <=> 1
-     * ```
+     * The reverse() function reverses the order of nodes in a singly linked list.
+     * @returns The reverse() method is returning the reversed SinglyLinkedList.
      */
     SinglyLinkedList.prototype.reverse = function () {
         var currentNode = this.head;
@@ -657,75 +637,80 @@ var SinglyLinkedList = /** @class */ (function () {
         return this;
     };
     /**
-     * The forEach() method executes a provided function once for each list node.
-     * ```ts
-     * new LinkedList(1, 2, 3).forEach(val => log(val)); // 1 2 3
-     * ```
-     * @param f Function to execute for each element, taking up to three arguments.
-     * @param reverse Indicates if the list should be walked in reverse order, default is false
+     * The `forEach` function iterates over a singly linked list and applies a callback function to each node, either in
+     * forward or reverse order.
+     * @param callbackFn - A callback function that will be called for each element in the linked list. It takes three
+     * parameters:
+     * @param [reverse=false] - A boolean value indicating whether to iterate over the linked list in reverse order. If set
+     * to true, the iteration will start from the tail of the linked list and move towards the head. If set to false
+     * (default), the iteration will start from the head and move towards the tail.
      */
-    SinglyLinkedList.prototype.forEach = function (f, reverse) {
+    SinglyLinkedList.prototype.forEach = function (callbackFn, reverse) {
         if (reverse === void 0) { reverse = false; }
-        var currentIndex = reverse ? this.length - 1 : 0;
+        var currentIndex = reverse ? this.size - 1 : 0;
         var currentNode = reverse ? this.tail : this.head;
         var modifier = reverse ? -1 : 1;
         var nextNode = reverse ? 'prev' : 'next';
         while (currentNode) {
-            f(currentNode.val, currentIndex, this);
+            callbackFn(currentNode.val, currentIndex, this);
             currentNode = currentNode[nextNode];
             currentIndex += modifier;
         }
     };
     /**
-     * The map() method creates a new list with the results of
-     * calling a provided function on every node in the calling list.
-     * ```ts
-     * new LinkedList(1, 2, 3).map(val => val + 10); // 11 <=> 12 <=> 13
-     * ```
-     * @param f Function that produces an node of the new list, taking up to three arguments
-     * @param reverse Indicates if the list should be mapped in reverse order, default is false
+     * The map function takes a callback function and applies it to each element in the linked list, returning a new linked
+     * list with the results.
+     * @param callbackFn - A callback function that will be applied to each element in the linked list. It takes three
+     * parameters:
+     * @param [reverse=false] - The `reverse` parameter is a boolean value that determines whether the mapping should be
+     * done in reverse order or not. If `reverse` is set to `true`, the mapping will be done in reverse order. If `reverse`
+     * is set to `false` or not provided, the mapping will be
+     * @returns The `map` function is returning a new `SinglyLinkedList` object.
      */
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    SinglyLinkedList.prototype.map = function (f, reverse) {
+    SinglyLinkedList.prototype.map = function (callbackFn, reverse) {
         var _this = this;
         if (reverse === void 0) { reverse = false; }
         var list = new SinglyLinkedList();
-        this.forEach(function (val, index) { return list.append(f(val, index, _this)); }, reverse);
+        this.forEach(function (val, index) { return list.append(callbackFn(val, index, _this)); }, reverse);
         return list;
     };
     /**
-     * The filter() method creates a new list with all nodes
-     * that pass the test implemented by the provided function.
-     * ```ts
-     * new LinkedList(1, 2, 3, 4, 5).filter(val => val < 4); // 1 <=> 2 <=> 3
-     * ```
-     * @param f Function to test each node val in the list. Return true to keep the node
-     * @param reverse Indicates if the list should be filtered in reverse order, default is false
+     * The `filter` function filters the elements of a singly linked list based on a given callback function.
+     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It should return a
+     * boolean value indicating whether the current element should be included in the filtered list or not.
+     * @param [reverse=false] - The `reverse` parameter is a boolean value that determines whether the filtered list should
+     * be reversed or not. If `reverse` is set to `true`, the filtered list will be in reverse order. If `reverse` is set
+     * to `false` or not provided, the filtered list will be in
+     * @returns The `filter` method is returning a new `SinglyLinkedList` object.
      */
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    SinglyLinkedList.prototype.filter = function (f, reverse) {
+    SinglyLinkedList.prototype.filter = function (callbackFn, reverse) {
         var _this = this;
         if (reverse === void 0) { reverse = false; }
         var list = new SinglyLinkedList();
         this.forEach(function (val, index) {
-            if (f(val, index, _this)) {
+            if (callbackFn(val, index, _this)) {
                 list.append(val);
             }
         }, reverse);
         return list;
     };
     /**
-     * Reduce over each node in the list
-     * ```ts
-     * new LinkedList(1, 2, 3).reduce(n => n += 1, 0); // 3
-     * ```
-     * @param f A reducer function
-     * @param start An initial value
-     * @returns The final state of the accumulator
-     */
-    SinglyLinkedList.prototype.reduce = function (f, start, reverse) {
+     * The `reduce` function iterates over a singly linked list and applies a callback function to each element,
+     * accumulating a single value.
+     * @param callbackFn - A callback function that will be called for each element in the linked list. It takes four
+     * parameters:
+     * @param {any} [start] - The `start` parameter is an optional initial value for the accumulator. If provided, the
+     * `reduce` function will start accumulating from this value. If not provided, the `reduce` function will use the value
+     * of the first element in the linked list as the initial value.
+     * @param [reverse=false] - A boolean value indicating whether to iterate over the linked list in reverse order. If set
+     * to true, the iteration will start from the tail of the linked list and move towards the head. If set to false
+     * (default), the iteration will start from the head and move towards the tail.
+     * @returns The `reduce` method returns the accumulated value after applying the callback function to each element in
+     * the linked list.
+     */
+    SinglyLinkedList.prototype.reduce = function (callbackFn, start, reverse) {
         if (reverse === void 0) { reverse = false; }
-        var currentIndex = reverse ? this.length - 1 : 0;
+        var currentIndex = reverse ? this.size - 1 : 0;
         var modifier = reverse ? -1 : 1;
         var nextNode = reverse ? 'prev' : 'next';
         var currentElement = reverse ? this.tail : this.head;
@@ -741,38 +726,33 @@ var SinglyLinkedList = /** @class */ (function () {
             throw new TypeError('Reduce of empty LinkedList with no initial value');
         }
         while (currentElement) {
-            result = f(result, currentElement.val, currentIndex, this);
+            result = callbackFn(result, currentElement.val, currentIndex, this);
             currentIndex += modifier;
             currentElement = currentElement[nextNode];
         }
         return result;
     };
     /**
-     * Convert the linked list to an array
-     * ```ts
-     * new LinkedList(1, 2, 3).toArray(); // [1, 2, 3]
-     * ```
+     * The toArray() function converts a NodeVal object into an array of NodeVal objects.
+     * @returns An array of NodeVal objects.
      */
     SinglyLinkedList.prototype.toArray = function () {
         return __spreadArray([], __read(this), false);
     };
     /**
-     * Convert a linked list to string
-     * ```ts
-     * new LinkedList('one', 'two', 'three').toString(' <=> ') === 'one <=> two <=> three';
-     * ```
-     * @param separator Optional string to be placed in between val nodes, default is one space
+     * The `toString` function takes an optional separator and returns a string representation of an array, with each
+     * element separated by the specified separator.
+     * @param [separator= ] - The separator parameter is a string that specifies the character(s) to be used as a separator
+     * between each element in the array when converting it to a string. By default, the separator is set to a space
+     * character (' ').
+     * @returns The toString method is being returned as a string.
      */
     SinglyLinkedList.prototype.toString = function (separator) {
         if (separator === void 0) { separator = ' '; }
         return this.reduce(function (s, val) { return "".concat(s).concat(separator).concat(val); });
     };
     /**
-     * The iterator implementation
-     * ```ts
-     * const list = new LinkedList(1, 2, 3);
-     * for (const val of list) { log(val); } // 1 2 3
-     * ```
+     * The function is an iterator that returns the values of each node in a linked list.
      */
     SinglyLinkedList.prototype[Symbol.iterator] = function () {
         var element;
@@ -792,7 +772,12 @@ var SinglyLinkedList = /** @class */ (function () {
             }
         });
     };
-    /** Private helper function to reduce duplication of pop() and shift() methods */
+    /**
+     * The function removes a node from either end of a singly linked list and returns its value.
+     * @param {SinglyLinkedListNode<NodeVal> | null} node - The `node` parameter is a reference to a node in a singly
+     * linked list. It can be either a `SinglyLinkedListNode` object or `null`.
+     * @returns The value of the removed node if the node is not null, otherwise undefined.
+     */
     SinglyLinkedList.prototype.removeFromAnyEnd = function (node) {
         return node !== null ? this.removeNode(node).val : undefined;
     };