collect-your-stuff 2.1.2 → 2.2.0

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

@@ -1,84 +1,82 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.Linker = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.reduce.js')
-const _ArrayElement = require('../arrayable/ArrayElement')
-/**
- * Linker represents a node in a LinkedList.
- * @extends ArrayElement
- */
-class Linker {
-  /**
-   * Create the new Linker instance, provide the data and optionally give the next Linker.
-   * @param {Object} [nodeData={}] The settings for the new linker.
-   * @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 = null,
-    next = null
-  } = {}) {
-    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
-    this.classType = Linker
-    /** The data stored in this linker. */
-    this.data = null
-    /** The linker after this one, or null when this is the last. */
-    this.next = null
-    this.data = data
-    this.next = next
-  }
-}
-/**
- * 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}
- */
-exports.Linker = Linker
-Linker.make = (linker, classType = Linker) => {
-  if (linker === null || typeof linker !== 'object') {
-    // It is not an object (or it is null), so instantiate the Linker with element as the data
-    return new classType({
-      data: linker
-    })
-  }
-  if (linker.classType) {
-    // Already valid Linker, return as-is
-    return linker
-  }
-  if (!('data' in linker)) {
-    // Not the settings for a linker (which would have data, even if it is falsy), so it is the data itself
-    linker = {
-      data: linker
-    }
-  }
-  // Create the new node as the configured #classType
-  return _ArrayElement.ArrayElement.make(linker, classType)
-}
-/**
- * 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}}
- */
-Linker.fromArray = (values = [], classType = Linker) => values.reduce((references, linker) => {
-  const newLinker = classType.make(linker, classType)
-  if (references.head === null) {
-    // Initialize the head and tail with the new node
-    return {
-      head: newLinker,
-      tail: newLinker
-    }
-  }
-  // Only update the tail once head has been set, tail is always the most recent node
-  references.tail.next = newLinker
-  references.tail = newLinker
-  return references
-}, {
-  head: null,
-  tail: null
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.Linker = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.reduce.js')
+const _ArrayElement = require('../arrayable/ArrayElement')
+/**
+ * Linker represents a node in a LinkedList.
+ * @extends ArrayElement
+ */
+class Linker {
+  /**
+   * Create the new Linker instance, provide the data and optionally give the next Linker.
+   * @param nodeData The settings for the new linker.
+   * @param nodeData.data The data to be stored in this linker
+   * @param nodeData.next The reference to the next linker if any
+   */
+  constructor ({
+    data = null,
+    next = null
+  } = {}) {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
+    this.classType = Linker
+    /** The data stored in this linker. */
+    this.data = null
+    /** The linker after this one, or null when this is the last. */
+    this.next = null
+    this.data = data
+    this.next = next
+  }
+}
+/**
+ * Make a new Linker from the data given if it is not already a valid Linker.
+ * @param linker Return a valid Linker instance from given data, or even an already valid one.
+ * @param classType Provide the type of IsLinker to use.
+ */
+exports.Linker = Linker
+Linker.make = (linker, classType = Linker) => {
+  if (linker === null || typeof linker !== 'object') {
+    // It is not an object (or it is null), so instantiate the Linker with element as the data
+    return new classType({
+      data: linker
+    })
+  }
+  if (linker.classType) {
+    // Already valid Linker, return as-is
+    return linker
+  }
+  if (!('data' in linker)) {
+    // Not the settings for a linker (which would have data, even if it is falsy), so it is the data itself
+    linker = {
+      data: linker
+    }
+  }
+  // Create the new node as the configured #classType
+  return _ArrayElement.ArrayElement.make(linker, classType)
+}
+/**
+ * Convert an array into Linker instances, return the head and tail Linkers.
+ * @param values Provide an array of data that will be converted to a chain of linkers.
+ * @param classType Provide the type of IsLinker to use.
+ */
+Linker.fromArray = (values = [], classType = Linker) => values.reduce((references, linker) => {
+  const newLinker = classType.make(linker, classType)
+  if (references.head === null) {
+    // Initialize the head and tail with the new node
+    return {
+      head: newLinker,
+      tail: newLinker
+    }
+  }
+  // Only update the tail once head has been set, tail is always the most recent node
+  references.tail.next = newLinker
+  references.tail = newLinker
+  return references
+}, {
+  head: null,
+  tail: null
+})

package/dist/collections/linked-tree-list/LinkedTreeList.d.ts

@@ -1,8 +1,5 @@
 /**
- * @file doubly linked tree list.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
+ * doubly linked tree list.
  */
 import { TreeLinker } from './TreeLinker';
 import { forEachCallback } from '../../recipes/IsArrayable';
@@ -29,131 +26,115 @@ export declare class LinkedTreeList implements IsTree, Iterable<TreeLinker> {
     private ownerNode;
     /**
      * Create the new LinkedTreeList instance, configure the list class.
-     * @param {TreeLinker} [linkerClass=TreeLinker] The class used to wrap given data as tree linkers.
+     * @param linkerClass The class used to wrap given data as tree linkers.
      */
     constructor(linkerClass?: typeof TreeLinker);
     /**
      * Initialize the inner list, should only run once.
-     * @param {TreeLinker} initialList Give the list of tree-linkers to start in this linked-tree-list.
-     * @return {LinkedTreeList}
+     * @param initialList Give the list of tree-linkers to start in this linked-tree-list.
      */
     initialize(initialList: TreeLinker): LinkedTreeList;
     /**
      * Retrieve the innerList used (the list itself, not a copy).
-     * @returns {TreeLinker}
      */
     get list(): TreeLinker;
     /**
      * Retrieve the first TreeLinker in the list.
-     * @returns {TreeLinker}
      */
     get first(): TreeLinker;
     /**
      * Retrieve the last TreeLinker in the list. The end is remembered, so this does not walk the list.
-     * @returns {TreeLinker}
      */
     get last(): TreeLinker;
     /**
      * Return the length of the list. It is kept up to date by the list's own methods, so this does not walk the list
      * (call reset() after linkers were changed directly).
-     * @returns {number}
      */
     get length(): number;
     /**
      * Get the parent of this tree list: the node these linkers are the children of (remembered even while the list is
      * empty), or null for the linkers at the top of a tree.
-     * @return {TreeLinker|null}
      */
     get parent(): TreeLinker | null;
     /**
      * Set the parent of this tree list: every linker in it gets the node as its parent, and the node gets this list as its
      * children. Linkers added to the list later get this parent too.
-     * @param {TreeLinker|null} parent The new node to use as the parent for this group of children
+     * @param parent The new node to use as the parent for this group of children
      */
     set parent(parent: TreeLinker | null);
     /**
      * Return the root parent of the entire tree.
-     * @return {TreeLinker}
      */
     get rootParent(): TreeLinker;
     /**
      * Set the children on a parent item.
-     * @param {TreeLinker} item The TreeLinker node (one of the linkers of this list) that will be the parent of the children
-     * @param {LinkedTreeList|null} [children=null] The LinkedTreeList which has the child nodes to use, or null to remove the children of the item
+     * @param item The TreeLinker node (one of the linkers of this list) that will be the parent of the children
+     * @param children The LinkedTreeList which has the child nodes to use, or null to remove the children of the item
      * @throws {Error} When the item is not one of the linkers of this list
      */
     setChildren(item: TreeLinker, children?: LinkedTreeList | null): void;
     /**
      * Make a linker of the given node (or data) and make this list's parent its parent.
-     * @param {TreeLinker|*} newNode The node (or data) which is being added to this list
-     * @returns {TreeLinker}
+     * @param newNode The node (or data) which is being added to this list
      */
     private adopt;
     /**
      * Insert a new node (or data) after a node. The new node gets the parent of this list.
-     * @param {TreeLinker|*} node The existing node as reference, or null to insert at the start of the list
-     * @param {TreeLinker|*} newNode The new node to go after the existing node
-     * @returns {LinkedTreeList}
+     * @param node The existing node as reference, or null to insert at the start of the list
+     * @param newNode The new node to go after the existing node
      */
     insertAfter(node: TreeLinker | null, newNode: TreeLinker | any): LinkedTreeList;
     /**
      * Insert a new node (or data) before a node. The new node gets the parent of this list.
-     * @param {TreeLinker|*} node The existing node as reference, or null to insert at the end of the list
-     * @param {TreeLinker|*} newNode The new node to go before the existing node
-     * @returns {LinkedTreeList}
+     * @param node The existing node as reference, or null to insert at the end of the list
+     * @param newNode The new node to go before the existing node
      */
     insertBefore(node: TreeLinker | null, newNode: TreeLinker | any): LinkedTreeList;
     /**
      * Add a node (or data) after the given (or last) node in the list.
-     * @param {TreeLinker|*} node The new node to add to the end of the list
-     * @param {TreeLinker} after The existing last node
-     * @returns {TreeLinker}
+     * @param node The new node to add to the end of the list
+     * @param after The existing last node
      */
     append(node: TreeLinker | any, after?: TreeLinker): LinkedTreeList;
     /**
      * Add a node (or data) before the given (or first) node in the list.
-     * @param {TreeLinker|*} node The new node to add to the start of the list
-     * @param {TreeLinker} before The existing first node
-     * @returns {TreeLinker}
+     * @param node The new node to add to the start of the list
+     * @param before The existing first node
      */
     prepend(node: TreeLinker | any, before?: TreeLinker): LinkedTreeList;
     /**
      * Remove a linker from this linked list. The removed node no longer has a parent.
-     * @param {TreeLinker} node The node we wish to remove (and it will be returned after removal)
-     * @return {TreeLinker|null} The removed node, or null when there was nothing to remove
+     * @param node The node we wish to remove (and it will be returned after removal)
+     * @returns The removed node, or null when there was nothing to remove
      */
     remove(node: TreeLinker): TreeLinker | null;
     /**
      * Refresh all references (the head, the end and the length) by walking the list once, and return the head. The
      * list's own methods keep these up to date, so this is only needed after linkers were changed directly.
-     * @return {TreeLinker}
      */
     reset(): TreeLinker;
     /**
      * Retrieve a TreeLinker item from this list by numeric index, otherwise return null.
-     * @param {number} index The integer number for retrieving a node by position.
-     * @returns {TreeLinker|null}
+     * @param index The integer number for retrieving a node by position.
      */
     item(index: number): TreeLinker;
     /**
      * Be able to run forEach on this LinkedTreeList to iterate over the TreeLinker Items.
-     * @param {forEachCallback} callback The function to call for-each tree node
-     * @param {LinkedTreeList} thisArg Optional, 'this' reference
-     * @return {LinkedTreeList} The list which was iterated.
+     * @param callback The function to call for-each tree node
+     * @param thisArg Optional, 'this' reference
+     * @returns The list which was iterated.
      */
     forEach(callback: forEachCallback, thisArg?: LinkedTreeList): LinkedTreeList;
     /**
      * Be able to iterate over this class: the linkers of this list and everything below them (left-first). It stays within
      * this list (it does not start at, or climb up to, the parents), use the parseTree service to parse a whole tree.
-     * @returns {Iterator}
      */
     [Symbol.iterator](): Iterator<TreeLinker>;
     /**
      * Convert an array into a LinkedTreeList instance, return the new instance.
-     * @param {Array} [values=[]] An array of values which will be converted to nodes in this tree-list
-     * @param {TreeLinker} [linkerClass=TreeLinker] The class to use for each node
-     * @param {IsArrayable<TreeLinker>} [classType=LinkedTreeList] Provide the type of IsArrayable to use.
-     * @returns {LinkedTreeList}
+     * @param values An array of values which will be converted to nodes in this tree-list
+     * @param linkerClass The class to use for each node
+     * @param classType Provide the type of IsArrayable to use.
      */
     static fromArray: (values?: Array<any>, linkerClass?: typeof TreeLinker, classType?: any) => IsTree | any;
 }