collect-your-stuff 1.2.7 → 1.2.8

package/dist/collections/linked-list/LinkedList.js

@@ -1,233 +1,233 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.LinkedList = void 0
-var _Linker = require('./Linker')
-var _LinkerIterator = require('../../recipes/LinkerIterator')
-var _Arrayable = require('../arrayable/Arrayable')
-/**
- * LinkedList represents a collection stored as a LinkedList with next references.
- * @extends Arrayable
- */
-class LinkedList {
-  /**
-   * Create the new LinkedList instance.
-   */
-  constructor (linkerClass = _Linker.Linker) {
-    this.classType = LinkedList
-    this.innerList = null
-    this.initialized = false
-    this.linkerClass = linkerClass
-  }
-
-  /**
-   * Initialize the inner list, should only run once.
-   * @param {Linker|Array} initialList Give the list of linkers to start in this linked-list.
-   * @return {LinkedList}
-   */
-  initialize (initialList) {
-    return _Arrayable.Arrayable.prototype.initialize.call(this, initialList)
-  }
-
-  /**
-   * Retrieve a copy of the innerList used.
-   * @returns {Linker}
-   */
-  get list () {
-    return this.innerList
-  }
-
-  /**
-   * Retrieve the first Linker in the list.
-   * @returns {Linker}
-   */
-  get first () {
-    return this.innerList
-  }
-
-  /**
-   * Retrieve the last Linker in the list.
-   * @returns {Linker}
-   */
-  get last () {
-    let tail = this.innerList
-    if (tail === null) {
-      return null
-    }
-    let next = tail.next
-    while (next !== null) {
-      tail = next
-      next = tail.next
-    }
-    return tail
-  }
-
-  /**
-   * Return the length of the list.
-   * @returns {number}
-   */
-  get length () {
-    let current = this.first
-    let length = 0
-    while (current !== null) {
-      ++length
-      current = current.next
-    }
-    return length
-  }
-
-  /**
-   * Insert a new node (or data) after a node.
-   * @param {Linker|*} node The existing node as reference
-   * @param {Linker|*} newNode The new node to go after the existing node
-   * @returns {LinkedList}
-   */
-  insertAfter (node, newNode) {
-    newNode = this.linkerClass.make(newNode)
-    if (node !== null) {
-      // Ensure the next reference of this node is assigned to the new node
-      newNode.next = node.next
-      // Then set this node's next reference to the new node
-      node.next = newNode
-    }
-    if (!this.length) {
-      this.innerList = newNode
-    }
-    return this
-  }
-
-  /**
-   * Insert a new node (or data) before a node.
-   * @param {Linker|*} node The existing node as reference
-   * @param {Linker|*} newNode The new node to go before the existing node
-   * @returns {LinkedList}
-   */
-  insertBefore (node, newNode) {
-    newNode = this.linkerClass.make(newNode)
-    let prevNode = null
-    let currentNode = this.first
-    while (currentNode !== node) {
-      prevNode = currentNode
-      currentNode = currentNode.next
-    }
-    // The new node will reference this node as next
-    newNode.next = node
-    if (prevNode) {
-      // Ensure the next reference of the previous node is assigned to the new node
-      prevNode.next = newNode
-    }
-    if (node === this.first || node === null) {
-      this.innerList = newNode
-    }
-    return this
-  }
-
-  /**
-   * Add a node (or data) after the given (or last) node in the list.
-   * @param {Linker|*} node The new node to add to the end of the list
-   * @param {Linker} after The existing last node
-   * @returns {Linker}
-   */
-  append (node, after = this.last) {
-    return this.insertAfter(after, node)
-  }
-
-  /**
-   * Add a node (or data) before the given (or first) node in the list.
-   * @param {Linker|*} node The new node to add to the start of the list
-   * @param {Linker} before The existing first node
-   * @returns {Linker}
-   */
-  prepend (node, before = this.first) {
-    return this.insertBefore(before, node)
-  }
-
-  /**
-   * Remove a linker from this linked list.
-   * @param {Linker} node The node we wish to remove (and it will be returned after removal)
-   * @return {Linker}
-   */
-  remove (node) {
-    let prevNode = null
-    let currentNode = this.first
-    while (currentNode !== node) {
-      prevNode = currentNode
-      currentNode = currentNode.next
-    }
-    if (prevNode) {
-      // Ensure the next reference of the previous node skips over the removed node
-      prevNode.next = node.next
-    }
-    if (node === this.first && node !== null) {
-      // Update list head to point to next if it was this node
-      this.innerList = node.next
-    }
-    return node
-  }
-
-  /**
-   * Retrieve a Linker item from this list by numeric index, otherwise return null.
-   * @param {number} index The integer number for retrieving a node by position.
-   * @returns {Linker|null}
-   */
-  item (index) {
-    if (index >= 0) {
-      let current = this.first
-      let currentIndex = -1
-      while (++currentIndex < index && current !== null) {
-        current = current.next
-      }
-      return currentIndex === index ? current : null
-    }
-    let current = this.first
-    let currentIndex = 0
-    const calculatedIndex = this.length + index
-    if (calculatedIndex < 0) {
-      return null
-    }
-    while (currentIndex < calculatedIndex && current !== null) {
-      current = current.next
-      ++currentIndex
-    }
-    return currentIndex === calculatedIndex ? current : null
-  }
-
-  /**
-   * Be able to run forEach on this LinkedList to iterate over the linkers.
-   * @param {forEachCallback} callback The function to call for-each linker
-   * @param {LinkedList} thisArg Optional, 'this' reference
-   * @returns {LinkedList}
-   */
-  forEach (callback, thisArg = this) {
-    let index = 0
-    let current = thisArg.first
-    while (current !== null) {
-      callback(current, index, thisArg)
-      current = current.next
-      ++index
-    }
-    return thisArg
-  }
-
-  /**
-   * Be able to iterate over this class.
-   * @returns {Iterator}
-   */
-  [Symbol.iterator] () {
-    return new _LinkerIterator.LinkerIterator(this.first)
-  }
-}
-/**
- * Convert an array to a LinkedList.
- * @param {Array} values An array of values which will be converted to linkers in this linked-list
- * @param {IsLinker} linkerClass The class to use for each linker
- * @param {IsArrayable<Linker>} [classType=LinkedList] Provide the type of IsArrayable to use.
- * @returns {LinkedList}
- */
-exports.LinkedList = LinkedList
-LinkedList.fromArray = (values = [], linkerClass = _Linker.Linker, classType = LinkedList) => {
-  const list = new classType(linkerClass)
-  return list.initialize(linkerClass.fromArray(values).head)
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.LinkedList = void 0
+var _Linker = require('./Linker')
+var _LinkerIterator = require('../../recipes/LinkerIterator')
+var _Arrayable = require('../arrayable/Arrayable')
+/**
+ * LinkedList represents a collection stored as a LinkedList with next references.
+ * @extends Arrayable
+ */
+class LinkedList {
+  /**
+   * Create the new LinkedList instance.
+   */
+  constructor (linkerClass = _Linker.Linker) {
+    this.classType = LinkedList
+    this.innerList = null
+    this.initialized = false
+    this.linkerClass = linkerClass
+  }
+
+  /**
+   * Initialize the inner list, should only run once.
+   * @param {Linker|Array} initialList Give the list of linkers to start in this linked-list.
+   * @return {LinkedList}
+   */
+  initialize (initialList) {
+    return _Arrayable.Arrayable.prototype.initialize.call(this, initialList)
+  }
+
+  /**
+   * Retrieve a copy of the innerList used.
+   * @returns {Linker}
+   */
+  get list () {
+    return this.innerList
+  }
+
+  /**
+   * Retrieve the first Linker in the list.
+   * @returns {Linker}
+   */
+  get first () {
+    return this.innerList
+  }
+
+  /**
+   * Retrieve the last Linker in the list.
+   * @returns {Linker}
+   */
+  get last () {
+    let tail = this.innerList
+    if (tail === null) {
+      return null
+    }
+    let next = tail.next
+    while (next !== null) {
+      tail = next
+      next = tail.next
+    }
+    return tail
+  }
+
+  /**
+   * Return the length of the list.
+   * @returns {number}
+   */
+  get length () {
+    let current = this.first
+    let length = 0
+    while (current !== null) {
+      ++length
+      current = current.next
+    }
+    return length
+  }
+
+  /**
+   * Insert a new node (or data) after a node.
+   * @param {Linker|*} node The existing node as reference
+   * @param {Linker|*} newNode The new node to go after the existing node
+   * @returns {LinkedList}
+   */
+  insertAfter (node, newNode) {
+    newNode = this.linkerClass.make(newNode)
+    if (node !== null) {
+      // Ensure the next reference of this node is assigned to the new node
+      newNode.next = node.next
+      // Then set this node's next reference to the new node
+      node.next = newNode
+    }
+    if (!this.length) {
+      this.innerList = newNode
+    }
+    return this
+  }
+
+  /**
+   * Insert a new node (or data) before a node.
+   * @param {Linker|*} node The existing node as reference
+   * @param {Linker|*} newNode The new node to go before the existing node
+   * @returns {LinkedList}
+   */
+  insertBefore (node, newNode) {
+    newNode = this.linkerClass.make(newNode)
+    let prevNode = null
+    let currentNode = this.first
+    while (currentNode !== node) {
+      prevNode = currentNode
+      currentNode = currentNode.next
+    }
+    // The new node will reference this node as next
+    newNode.next = node
+    if (prevNode) {
+      // Ensure the next reference of the previous node is assigned to the new node
+      prevNode.next = newNode
+    }
+    if (node === this.first || node === null) {
+      this.innerList = newNode
+    }
+    return this
+  }
+
+  /**
+   * Add a node (or data) after the given (or last) node in the list.
+   * @param {Linker|*} node The new node to add to the end of the list
+   * @param {Linker} after The existing last node
+   * @returns {Linker}
+   */
+  append (node, after = this.last) {
+    return this.insertAfter(after, node)
+  }
+
+  /**
+   * Add a node (or data) before the given (or first) node in the list.
+   * @param {Linker|*} node The new node to add to the start of the list
+   * @param {Linker} before The existing first node
+   * @returns {Linker}
+   */
+  prepend (node, before = this.first) {
+    return this.insertBefore(before, node)
+  }
+
+  /**
+   * Remove a linker from this linked list.
+   * @param {Linker} node The node we wish to remove (and it will be returned after removal)
+   * @return {Linker}
+   */
+  remove (node) {
+    let prevNode = null
+    let currentNode = this.first
+    while (currentNode !== node) {
+      prevNode = currentNode
+      currentNode = currentNode.next
+    }
+    if (prevNode) {
+      // Ensure the next reference of the previous node skips over the removed node
+      prevNode.next = node.next
+    }
+    if (node === this.first && node !== null) {
+      // Update list head to point to next if it was this node
+      this.innerList = node.next
+    }
+    return node
+  }
+
+  /**
+   * Retrieve a Linker item from this list by numeric index, otherwise return null.
+   * @param {number} index The integer number for retrieving a node by position.
+   * @returns {Linker|null}
+   */
+  item (index) {
+    if (index >= 0) {
+      let current = this.first
+      let currentIndex = -1
+      while (++currentIndex < index && current !== null) {
+        current = current.next
+      }
+      return currentIndex === index ? current : null
+    }
+    let current = this.first
+    let currentIndex = 0
+    const calculatedIndex = this.length + index
+    if (calculatedIndex < 0) {
+      return null
+    }
+    while (currentIndex < calculatedIndex && current !== null) {
+      current = current.next
+      ++currentIndex
+    }
+    return currentIndex === calculatedIndex ? current : null
+  }
+
+  /**
+   * Be able to run forEach on this LinkedList to iterate over the linkers.
+   * @param {forEachCallback} callback The function to call for-each linker
+   * @param {LinkedList} thisArg Optional, 'this' reference
+   * @returns {LinkedList}
+   */
+  forEach (callback, thisArg = this) {
+    let index = 0
+    let current = thisArg.first
+    while (current !== null) {
+      callback(current, index, thisArg)
+      current = current.next
+      ++index
+    }
+    return thisArg
+  }
+
+  /**
+   * Be able to iterate over this class.
+   * @returns {Iterator}
+   */
+  [Symbol.iterator] () {
+    return new _LinkerIterator.LinkerIterator(this.first)
+  }
+}
+/**
+ * Convert an array to a LinkedList.
+ * @param {Array} values An array of values which will be converted to linkers in this linked-list
+ * @param {IsLinker} linkerClass The class to use for each linker
+ * @param {IsArrayable<Linker>} [classType=LinkedList] Provide the type of IsArrayable to use.
+ * @returns {LinkedList}
+ */
+exports.LinkedList = LinkedList
+LinkedList.fromArray = (values = [], linkerClass = _Linker.Linker, classType = LinkedList) => {
+  const list = new classType(linkerClass)
+  return list.initialize(linkerClass.fromArray(values).head)
+}

package/dist/collections/linked-list/Linker.d.ts

@@ -1,43 +1,43 @@
-/**
- * @file linked list item.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { IsLinker } from '../../recipes/IsLinker';
-/**
- * Linker represents a node in a LinkedList.
- * @extends ArrayElement
- */
-export declare class Linker implements IsLinker {
-    readonly classType: typeof Linker;
-    data: any;
-    next: Linker | null;
-    /**
-     * Create the new Linker instance, provide the data and optionally give the next Linker.
-     * @param {Object} [nodeData={}]
-     * @param {*} [nodeData.data=null] The data to be stored in this linker
-     * @param {Linker|null} [nodeData.next=null] The reference to the next linker if any
-     */
-    constructor({ data, next }?: {
-        data?: any;
-        next?: Linker | null;
-    });
-    /**
-     * Make a new Linker from the data given if it is not already a valid Linker.
-     * @param {Linker|*} linker Return a valid Linker instance from given data, or even an already valid one.
-     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
-     * @return {Linker}
-     */
-    static make: (linker: Linker | any, classType?: any) => IsLinker | any;
-    /**
-     * Convert an array into Linker instances, return the head and tail Linkers.
-     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of linkers.
-     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
-     * @returns {{head: Linker, tail: Linker}}
-     */
-    static fromArray: (values: Array<any>, classType?: any) => {
-        head: IsLinker;
-        tail: IsLinker;
-    };
-}
+/**
+ * @file linked list item.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+import { IsLinker } from '../../recipes/IsLinker';
+/**
+ * Linker represents a node in a LinkedList.
+ * @extends ArrayElement
+ */
+export declare class Linker implements IsLinker {
+    readonly classType: typeof Linker;
+    data: any;
+    next: Linker | null;
+    /**
+     * Create the new Linker instance, provide the data and optionally give the next Linker.
+     * @param {Object} [nodeData={}]
+     * @param {*} [nodeData.data=null] The data to be stored in this linker
+     * @param {Linker|null} [nodeData.next=null] The reference to the next linker if any
+     */
+    constructor({ data, next }?: {
+        data?: any;
+        next?: Linker | null;
+    });
+    /**
+     * Make a new Linker from the data given if it is not already a valid Linker.
+     * @param {Linker|*} linker Return a valid Linker instance from given data, or even an already valid one.
+     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
+     * @return {Linker}
+     */
+    static make: (linker: Linker | any, classType?: any) => IsLinker | any;
+    /**
+     * Convert an array into Linker instances, return the head and tail Linkers.
+     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of linkers.
+     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
+     * @returns {{head: Linker, tail: Linker}}
+     */
+    static fromArray: (values: Array<any>, classType?: any) => {
+        head: IsLinker;
+        tail: IsLinker;
+    };
+}