collect-your-stuff 1.2.7 → 1.2.8

package/dist/collections/linked-tree-list/LinkedTreeList.js

@@ -1,252 +1,252 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.LinkedTreeList = void 0
-var _TreeLinker = require('./TreeLinker')
-var _TreeLinkerIterator = require('../../recipes/TreeLinkerIterator')
-var _DoublyLinkedList = require('../doubly-linked-list/DoublyLinkedList')
-/**
- * @file doubly linked tree list.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-
-/**
- * LinkedTreeList represents a collection stored with a root and spreading in branching (tree) formation.
- * @extends DoublyLinkedList
- */
-class LinkedTreeList {
-  /**
-   * Create the new LinkedTreeList instance, configure the list class.
-   */
-  constructor (linkerClass = _TreeLinker.TreeLinker) {
-    this.classType = LinkedTreeList
-    this.innerList = null
-    this.initialized = false
-    this.linkerClass = linkerClass
-  }
-
-  /**
-   * 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}
-   */
-  initialize (initialList) {
-    if (this.initialized) {
-      console.warn('Attempt to initialize LinkedTreeList which is not empty.')
-      return this
-    }
-    this.initialized = true
-    this.innerList = initialList
-    return this
-  }
-
-  /**
-   * Retrieve a copy of the innerList used.
-   * @returns {TreeLinker}
-   */
-  get list () {
-    return this.innerList
-  }
-
-  /**
-   * Retrieve the first TreeLinker in the list.
-   * @returns {TreeLinker}
-   */
-  get first () {
-    return this.reset()
-  }
-
-  /**
-   * Retrieve the last TreeLinker in the list.
-   * @returns {TreeLinker}
-   */
-  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
-  }
-
-  /**
-   * Get the parent of this tree list.
-   * @return {TreeLinker}
-   */
-  get parent () {
-    const first = this.first
-    if (first === null) {
-      return null
-    }
-    return this.first.parent
-  }
-
-  /**
-   * Set the parent of this tree list
-   * @param {TreeLinker} parent The new node to use as the parent for this group of children
-   */
-  set parent (parent) {
-    let current = this.first
-    while (current !== null) {
-      current.parent = parent
-      current = current.next
-    }
-    if (parent) {
-      parent.children = this
-    }
-  }
-
-  /**
-   * Return the root parent of the entire tree.
-   * @return {TreeLinker}
-   */
-  get rootParent () {
-    let current = this.first
-    if (!current) {
-      return null
-    }
-    let parent = this.first.parent
-    while (parent !== null) {
-      current = parent
-      parent = current.parent
-    }
-    return current
-  }
-
-  /**
-   * Set the children on a parent item.
-   * @param {TreeLinker} item The TreeLinker node that will be the parent of the children
-   * @param {LinkedTreeList} children The LinkedTreeList which has the child nodes to use
-   */
-  setChildren (item, children = null) {
-    if (Array.from(this).indexOf(item) < 0) {
-      console.error('item is not a child of this')
-    }
-    children.parent = item
-  }
-
-  /**
-   * Insert a new node (or data) after a node.
-   * @param {TreeLinker|*} node The existing node as reference
-   * @param {TreeLinker|*} newNode The new node to go after the existing node
-   * @returns {LinkedTreeList}
-   */
-  insertAfter (node, newNode) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.insertAfter.call(this, node, newNode)
-  }
-
-  /**
-   * Insert a new node (or data) before a node.
-   * @param {TreeLinker|*} node The existing node as reference
-   * @param {TreeLinker|*} newNode The new node to go before the existing node
-   * @returns {LinkedTreeList}
-   */
-  insertBefore (node, newNode) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.insertBefore.call(this, node, newNode)
-  }
-
-  /**
-   * 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}
-   */
-  append (node, after = this.last) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.append.call(this, node, after)
-  }
-
-  /**
-   * 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}
-   */
-  prepend (node, before = this.first) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.prepend.call(this, node, before)
-  }
-
-  /**
-   * Remove a linker from this linked list.
-   * @param {TreeLinker} node The node we wish to remove (and it will be returned after removal)
-   * @return {TreeLinker}
-   */
-  remove (node) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.remove.call(this, node)
-  }
-
-  /**
-   * Refresh all references and return head reference.
-   * @return {TreeLinker}
-   */
-  reset () {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.reset.call(this)
-  }
-
-  /**
-   * 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}
-   */
-  item (index) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.item.call(this, index)
-  }
-
-  /**
-   * 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
-   */
-  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] () {
-    const root = this.rootParent
-    return new _TreeLinkerIterator.TreeLinkerIterator(root)
-  }
-}
-/**
- * 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}
- */
-exports.LinkedTreeList = LinkedTreeList
-LinkedTreeList.fromArray = (values = [], linkerClass = _TreeLinker.TreeLinker, classType = LinkedTreeList) => {
-  const list = new classType(linkerClass)
-  return list.initialize(linkerClass.fromArray(values).head)
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.LinkedTreeList = void 0
+var _TreeLinker = require('./TreeLinker')
+var _TreeLinkerIterator = require('../../recipes/TreeLinkerIterator')
+var _DoublyLinkedList = require('../doubly-linked-list/DoublyLinkedList')
+/**
+ * @file doubly linked tree list.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+
+/**
+ * LinkedTreeList represents a collection stored with a root and spreading in branching (tree) formation.
+ * @extends DoublyLinkedList
+ */
+class LinkedTreeList {
+  /**
+   * Create the new LinkedTreeList instance, configure the list class.
+   */
+  constructor (linkerClass = _TreeLinker.TreeLinker) {
+    this.classType = LinkedTreeList
+    this.innerList = null
+    this.initialized = false
+    this.linkerClass = linkerClass
+  }
+
+  /**
+   * 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}
+   */
+  initialize (initialList) {
+    if (this.initialized) {
+      console.warn('Attempt to initialize LinkedTreeList which is not empty.')
+      return this
+    }
+    this.initialized = true
+    this.innerList = initialList
+    return this
+  }
+
+  /**
+   * Retrieve a copy of the innerList used.
+   * @returns {TreeLinker}
+   */
+  get list () {
+    return this.innerList
+  }
+
+  /**
+   * Retrieve the first TreeLinker in the list.
+   * @returns {TreeLinker}
+   */
+  get first () {
+    return this.reset()
+  }
+
+  /**
+   * Retrieve the last TreeLinker in the list.
+   * @returns {TreeLinker}
+   */
+  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
+  }
+
+  /**
+   * Get the parent of this tree list.
+   * @return {TreeLinker}
+   */
+  get parent () {
+    const first = this.first
+    if (first === null) {
+      return null
+    }
+    return this.first.parent
+  }
+
+  /**
+   * Set the parent of this tree list
+   * @param {TreeLinker} parent The new node to use as the parent for this group of children
+   */
+  set parent (parent) {
+    let current = this.first
+    while (current !== null) {
+      current.parent = parent
+      current = current.next
+    }
+    if (parent) {
+      parent.children = this
+    }
+  }
+
+  /**
+   * Return the root parent of the entire tree.
+   * @return {TreeLinker}
+   */
+  get rootParent () {
+    let current = this.first
+    if (!current) {
+      return null
+    }
+    let parent = this.first.parent
+    while (parent !== null) {
+      current = parent
+      parent = current.parent
+    }
+    return current
+  }
+
+  /**
+   * Set the children on a parent item.
+   * @param {TreeLinker} item The TreeLinker node that will be the parent of the children
+   * @param {LinkedTreeList} children The LinkedTreeList which has the child nodes to use
+   */
+  setChildren (item, children = null) {
+    if (Array.from(this).indexOf(item) < 0) {
+      console.error('item is not a child of this')
+    }
+    children.parent = item
+  }
+
+  /**
+   * Insert a new node (or data) after a node.
+   * @param {TreeLinker|*} node The existing node as reference
+   * @param {TreeLinker|*} newNode The new node to go after the existing node
+   * @returns {LinkedTreeList}
+   */
+  insertAfter (node, newNode) {
+    return _DoublyLinkedList.DoublyLinkedList.prototype.insertAfter.call(this, node, newNode)
+  }
+
+  /**
+   * Insert a new node (or data) before a node.
+   * @param {TreeLinker|*} node The existing node as reference
+   * @param {TreeLinker|*} newNode The new node to go before the existing node
+   * @returns {LinkedTreeList}
+   */
+  insertBefore (node, newNode) {
+    return _DoublyLinkedList.DoublyLinkedList.prototype.insertBefore.call(this, node, newNode)
+  }
+
+  /**
+   * 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}
+   */
+  append (node, after = this.last) {
+    return _DoublyLinkedList.DoublyLinkedList.prototype.append.call(this, node, after)
+  }
+
+  /**
+   * 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}
+   */
+  prepend (node, before = this.first) {
+    return _DoublyLinkedList.DoublyLinkedList.prototype.prepend.call(this, node, before)
+  }
+
+  /**
+   * Remove a linker from this linked list.
+   * @param {TreeLinker} node The node we wish to remove (and it will be returned after removal)
+   * @return {TreeLinker}
+   */
+  remove (node) {
+    return _DoublyLinkedList.DoublyLinkedList.prototype.remove.call(this, node)
+  }
+
+  /**
+   * Refresh all references and return head reference.
+   * @return {TreeLinker}
+   */
+  reset () {
+    return _DoublyLinkedList.DoublyLinkedList.prototype.reset.call(this)
+  }
+
+  /**
+   * 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}
+   */
+  item (index) {
+    return _DoublyLinkedList.DoublyLinkedList.prototype.item.call(this, index)
+  }
+
+  /**
+   * 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
+   */
+  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] () {
+    const root = this.rootParent
+    return new _TreeLinkerIterator.TreeLinkerIterator(root)
+  }
+}
+/**
+ * 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}
+ */
+exports.LinkedTreeList = LinkedTreeList
+LinkedTreeList.fromArray = (values = [], linkerClass = _TreeLinker.TreeLinker, classType = LinkedTreeList) => {
+  const list = new classType(linkerClass)
+  return list.initialize(linkerClass.fromArray(values).head)
+}

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

@@ -1,63 +1,63 @@
-/**
- * @file doubly linked tree node.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { IsArrayable } from '../../recipes/IsArrayable';
-import { IsTreeNode } from '../../recipes/IsTreeNode';
-import { IsTree } from '../../recipes/IsTree';
-/**
- * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
- * @extends DoubleLinker
- */
-export declare class TreeLinker implements IsTreeNode {
-    readonly classType: typeof TreeLinker;
-    data: any;
-    next: IsTreeNode | null;
-    prev: IsTreeNode | null;
-    parent: IsTreeNode;
-    children: IsArrayable<IsTreeNode>;
-    /**
-     * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
-     * @param {Object} [settings={}]
-     * @param {*} [settings.data=null] The data to be stored in this tree node
-     * @param {TreeLinker} [settings.next=null] The reference to the next linker if any
-     * @param {TreeLinker} [settings.prev=null] The reference to the previous linker if any
-     * @param {LinkedTreeList} [settings.children=null] The references to child linkers if any
-     * @param {TreeLinker} [settings.parent=null] The reference to a parent linker if any
-     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
-     */
-    constructor({ data, next, prev, children, parent, listClass }?: {
-        data?: any;
-        next?: IsTreeNode;
-        prev?: IsTreeNode;
-        children?: Array<any>;
-        parent?: IsTreeNode;
-        listClass?: any;
-    });
-    /**
-     * Create the children for this tree from an array.
-     * @param {Array|null} children Provide an array of data / linker references to be children of this tree node.
-     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
-     * @return {LinkedTreeList|null}
-     */
-    childrenFromArray(children?: Array<any> | null, listClass?: any): IsTree | any;
-    /**
-     * Make a new DoubleLinker from the data given if it is not already a valid Linker.
-     * @param {TreeLinker|*} linker Return a valid TreeLinker instance from given data, or even an already valid one.
-     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
-     * @return {TreeLinker}
-     */
-    static make: (linker: TreeLinker | any, classType?: any) => IsTreeNode | any;
-    /**
-     * Convert an array into DoubleLinker instances, return the head and tail DoubleLinkers.
-     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of tree-linkers.
-     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
-     * @returns {{head: TreeLinker, tail: TreeLinker}}
-     */
-    static fromArray: (values?: Array<any>, classType?: any) => {
-        head: TreeLinker | any;
-        tail: TreeLinker | any;
-    };
-}
+/**
+ * @file doubly linked tree node.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+import { IsArrayable } from '../../recipes/IsArrayable';
+import { IsTreeNode } from '../../recipes/IsTreeNode';
+import { IsTree } from '../../recipes/IsTree';
+/**
+ * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
+ * @extends DoubleLinker
+ */
+export declare class TreeLinker implements IsTreeNode {
+    readonly classType: typeof TreeLinker;
+    data: any;
+    next: IsTreeNode | null;
+    prev: IsTreeNode | null;
+    parent: IsTreeNode;
+    children: IsArrayable<IsTreeNode>;
+    /**
+     * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
+     * @param {Object} [settings={}]
+     * @param {*} [settings.data=null] The data to be stored in this tree node
+     * @param {TreeLinker} [settings.next=null] The reference to the next linker if any
+     * @param {TreeLinker} [settings.prev=null] The reference to the previous linker if any
+     * @param {LinkedTreeList} [settings.children=null] The references to child linkers if any
+     * @param {TreeLinker} [settings.parent=null] The reference to a parent linker if any
+     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
+     */
+    constructor({ data, next, prev, children, parent, listClass }?: {
+        data?: any;
+        next?: IsTreeNode;
+        prev?: IsTreeNode;
+        children?: Array<any>;
+        parent?: IsTreeNode;
+        listClass?: any;
+    });
+    /**
+     * Create the children for this tree from an array.
+     * @param {Array|null} children Provide an array of data / linker references to be children of this tree node.
+     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
+     * @return {LinkedTreeList|null}
+     */
+    childrenFromArray(children?: Array<any> | null, listClass?: any): IsTree | any;
+    /**
+     * Make a new DoubleLinker from the data given if it is not already a valid Linker.
+     * @param {TreeLinker|*} linker Return a valid TreeLinker instance from given data, or even an already valid one.
+     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
+     * @return {TreeLinker}
+     */
+    static make: (linker: TreeLinker | any, classType?: any) => IsTreeNode | any;
+    /**
+     * Convert an array into DoubleLinker instances, return the head and tail DoubleLinkers.
+     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of tree-linkers.
+     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
+     * @returns {{head: TreeLinker, tail: TreeLinker}}
+     */
+    static fromArray: (values?: Array<any>, classType?: any) => {
+        head: TreeLinker | any;
+        tail: TreeLinker | any;
+    };
+}