collect-your-stuff 2.1.2 → 2.2.0

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

@@ -1,94 +1,91 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.TreeLinker = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.map.js')
-const _DoubleLinker = require('../doubly-linked-list/DoubleLinker')
-const _LinkedTreeList = require('./LinkedTreeList')
-/**
- * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
- * @extends DoubleLinker
- */
-class TreeLinker {
-  /**
-   * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
-   * @param {Object} [settings={}] The settings for the new tree node.
-   * @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 = null,
-    next = null,
-    prev = null,
-    children = null,
-    parent = null,
-    listClass = _LinkedTreeList.LinkedTreeList
-  } = {}) {
-    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
-    this.classType = TreeLinker
-    /** The data stored in this tree node. */
-    this.data = null
-    /** The sibling after this node, or null when this is the last child. */
-    this.next = null
-    /** The sibling before this node, or null when this is the first child. */
-    this.prev = null
-    /** The node this node is a child of, or null for a root node. */
-    this.parent = null
-    /** The list of the children of this node, or null when it has none. */
-    this.children = null
-    this.data = data
-    this.next = next
-    this.prev = prev
-    this.parent = parent
-    this.children = this.childrenFromArray(children, listClass)
-  }
-
-  /**
-   * Create the children for this tree from an array. Each child becomes a tree linker with this node as its parent: an
-   * existing linker is kept as it is, an object with a data property gives the settings of the linker, and anything
-   * else is the data of the linker.
-   * @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 = null, listClass = _LinkedTreeList.LinkedTreeList) {
-    if (children === null) {
-      return null
-    }
-    // Every child is made into a tree linker (an existing one is kept as it is, and a plain value is the data) and is
-    // given this node as its parent
-    const nodes = children.map(child => {
-      const linker = this.classType.make(child, this.classType)
-      linker.parent = this
-      return linker
-    })
-    // Creates a linked-tree-list to store the children, which remembers this node as its parent even when it is empty
-    const list = listClass.fromArray(nodes, this.classType)
-    list.parent = this
-    return list
-  }
-}
-/**
- * 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}
- */
-exports.TreeLinker = TreeLinker
-TreeLinker.make = (linker, classType = TreeLinker) => {
-  return _DoubleLinker.DoubleLinker.make(linker, classType)
-}
-/**
- * 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}}
- */
-TreeLinker.fromArray = (values = [], classType = TreeLinker) => _DoubleLinker.DoubleLinker.fromArray(values, classType)
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.TreeLinker = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.map.js')
+const _DoubleLinker = require('../doubly-linked-list/DoubleLinker')
+const _LinkedTreeList = require('./LinkedTreeList')
+/**
+ * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
+ * @extends DoubleLinker
+ */
+class TreeLinker {
+  /**
+   * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
+   * @param settings The settings for the new tree node.
+   * @param settings.data The data to be stored in this tree node
+   * @param settings.next The reference to the next linker if any
+   * @param settings.prev The reference to the previous linker if any
+   * @param settings.children The references to child linkers if any
+   * @param settings.parent The reference to a parent linker if any
+   * @param listClass Give the type of list to use for storing the children
+   */
+  constructor ({
+    data = null,
+    next = null,
+    prev = null,
+    children = null,
+    parent = null,
+    listClass = _LinkedTreeList.LinkedTreeList
+  } = {}) {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
+    this.classType = TreeLinker
+    /** The data stored in this tree node. */
+    this.data = null
+    /** The sibling after this node, or null when this is the last child. */
+    this.next = null
+    /** The sibling before this node, or null when this is the first child. */
+    this.prev = null
+    /** The node this node is a child of, or null for a root node. */
+    this.parent = null
+    /** The list of the children of this node, or null when it has none. */
+    this.children = null
+    this.data = data
+    this.next = next
+    this.prev = prev
+    this.parent = parent
+    this.children = this.childrenFromArray(children, listClass)
+  }
+
+  /**
+   * Create the children for this tree from an array. Each child becomes a tree linker with this node as its parent: an
+   * existing linker is kept as it is, an object with a data property gives the settings of the linker, and anything
+   * else is the data of the linker.
+   * @param children Provide an array of data / linker references to be children of this tree node.
+   * @param listClass Give the type of list to use for storing the children
+   */
+  childrenFromArray (children = null, listClass = _LinkedTreeList.LinkedTreeList) {
+    if (children === null) {
+      return null
+    }
+    // Every child is made into a tree linker (an existing one is kept as it is, and a plain value is the data) and is
+    // given this node as its parent
+    const nodes = children.map(child => {
+      const linker = this.classType.make(child, this.classType)
+      linker.parent = this
+      return linker
+    })
+    // Creates a linked-tree-list to store the children, which remembers this node as its parent even when it is empty
+    const list = listClass.fromArray(nodes, this.classType)
+    list.parent = this
+    return list
+  }
+}
+/**
+ * Make a new DoubleLinker from the data given if it is not already a valid Linker.
+ * @param linker Return a valid TreeLinker instance from given data, or even an already valid one.
+ * @param classType Provide the type of IsTreeNode to use.
+ */
+exports.TreeLinker = TreeLinker
+TreeLinker.make = (linker, classType = TreeLinker) => {
+  return _DoubleLinker.DoubleLinker.make(linker, classType)
+}
+/**
+ * Convert an array into DoubleLinker instances, return the head and tail DoubleLinkers.
+ * @param values Provide an array of data that will be converted to a chain of tree-linkers.
+ * @param classType Provide the type of IsTreeNode to use.
+ */
+TreeLinker.fromArray = (values = [], classType = TreeLinker) => _DoubleLinker.DoubleLinker.fromArray(values, classType)

package/dist/collections/queue/Queue.d.ts

@@ -12,48 +12,44 @@ export declare class Queue<T = any> implements IsQueue<T>, Iterable<T> {
     private readonly linkerClass;
     /**
      * Instantiate the queue, optionally with a list of items to start from.
-     * @param {IsArrayable|null} [queuedList=null] The list of linkers to start in this queue (the first is the front)
-     * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no queued list is given
-     * @param {Linker} [linkerClass=Linker] The class used to hold each queued item
+     * @param queuedList The list of linkers to start in this queue (the first is the front)
+     * @param listClass The type of list to create when no queued list is given
+     * @param linkerClass The class used to hold each queued item
      */
     constructor(queuedList?: IsArrayable<any> | null, listClass?: any, linkerClass?: typeof Linker);
     /**
      * Take the item from the front of the queue.
-     * @return {*|null} The item, or null when the queue is empty
+     * @returns The item, or null when the queue is empty
      */
     dequeue(): T | null;
     /**
      * Check whether the queue has no items.
-     * @return {boolean}
      */
     empty(): boolean;
     /**
      * Add an item to the back of the queue.
-     * @param {*} data The item to add
-     * @return {Queue} This queue, so that adding can be chained
+     * @param data The item to add
+     * @returns This queue, so that adding can be chained
      */
     enqueue(data: T): this;
     /**
      * Look at the item at the front of the queue, without removing it.
-     * @return {*|null} The item, or null when the queue is empty
+     * @returns The item, or null when the queue is empty
      */
     peek(): T | null;
     /**
      * Count the items in the queue.
-     * @return {number}
      */
     size(): number;
     /**
      * Iterate over the items from the front of the queue to the back, without removing them.
-     * @return {Iterator}
      */
     [Symbol.iterator](): Iterator<T>;
     /**
      * Convert an array to a Queue, the first value is at the front.
-     * @param {Array} [values=[]] The items to queue
-     * @param {IsArrayable} [listClass=LinkedList] The type of list used to store the items
-     * @param {Linker} [linkerClass=Linker] The class used to hold each queued item
-     * @returns {Queue}
+     * @param values The items to queue
+     * @param listClass The type of list used to store the items
+     * @param linkerClass The class used to hold each queued item
      */
     static fromArray: <T_1 = any>(values?: Array<T_1>, listClass?: any, linkerClass?: typeof Linker) => Queue<T_1>;
 }

package/dist/collections/queue/Queue.js

@@ -1,121 +1,114 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.Queue = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.for-each.js')
-const _LinkedList = require('../linked-list/LinkedList')
-const _Linker = require('../linked-list/Linker')
-/**
- * @file queue
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 2.0.0
- * @memberOf module:collect-your-stuff
- */
-
-/**
- * A first-in-first-out collection: items are added to the back with enqueue and taken from the front with dequeue.
- * Any value can be queued (it is stored as it is, whether it is a function, an object or null), and adding and taking
- * are constant time. To queue tasks which are run as they are taken use TaskQueue.
- */
-class Queue {
-  /**
-   * Instantiate the queue, optionally with a list of items to start from.
-   * @param {IsArrayable|null} [queuedList=null] The list of linkers to start in this queue (the first is the front)
-   * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no queued list is given
-   * @param {Linker} [linkerClass=Linker] The class used to hold each queued item
-   */
-  constructor (queuedList = null, listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) {
-    this.linkerClass = linkerClass
-    this.queuedList = queuedList === null ? new listClass(linkerClass) : queuedList
-  }
-
-  /**
-   * Take the item from the front of the queue.
-   * @return {*|null} The item, or null when the queue is empty
-   */
-  dequeue () {
-    const front = this.queuedList.first
-    if (front === null || typeof front === 'undefined') {
-      return null
-    }
-    this.queuedList.remove(front)
-    return front.data
-  }
-
-  /**
-   * Check whether the queue has no items.
-   * @return {boolean}
-   */
-  empty () {
-    return this.size() <= 0
-  }
-
-  /**
-   * Add an item to the back of the queue.
-   * @param {*} data The item to add
-   * @return {Queue} This queue, so that adding can be chained
-   */
-  enqueue (data) {
-    // The item is wrapped here rather than left to the list, since the list treats objects that look like a linker's
-    // settings (they have a data property) as such, and a queue must give back exactly what it was given
-    this.queuedList.append(new this.linkerClass({
-      data
-    }))
-    return this
-  }
-
-  /**
-   * Look at the item at the front of the queue, without removing it.
-   * @return {*|null} The item, or null when the queue is empty
-   */
-  peek () {
-    const front = this.queuedList.first
-    return front === null || typeof front === 'undefined' ? null : front.data
-  }
-
-  /**
-   * Count the items in the queue.
-   * @return {number}
-   */
-  size () {
-    return this.queuedList.length
-  }
-
-  /**
-   * Iterate over the items from the front of the queue to the back, without removing them.
-   * @return {Iterator}
-   */
-  [Symbol.iterator] () {
-    const linkers = this.queuedList[Symbol.iterator]()
-    return {
-      next: () => {
-        const result = linkers.next()
-        return result.done
-          ? {
-              done: true,
-              value: undefined
-            }
-          : {
-              done: false,
-              value: result.value.data
-            }
-      }
-    }
-  }
-}
-/**
- * Convert an array to a Queue, the first value is at the front.
- * @param {Array} [values=[]] The items to queue
- * @param {IsArrayable} [listClass=LinkedList] The type of list used to store the items
- * @param {Linker} [linkerClass=Linker] The class used to hold each queued item
- * @returns {Queue}
- */
-exports.Queue = Queue
-Queue.fromArray = (values = [], listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) => {
-  const queue = new Queue(null, listClass, linkerClass)
-  values.forEach(value => queue.enqueue(value))
-  return queue
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.Queue = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.for-each.js')
+const _LinkedList = require('../linked-list/LinkedList')
+const _Linker = require('../linked-list/Linker')
+/**
+ * queue
+ */
+
+/**
+ * A first-in-first-out collection: items are added to the back with enqueue and taken from the front with dequeue.
+ * Any value can be queued (it is stored as it is, whether it is a function, an object or null), and adding and taking
+ * are constant time. To queue tasks which are run as they are taken use TaskQueue.
+ */
+class Queue {
+  /**
+   * Instantiate the queue, optionally with a list of items to start from.
+   * @param queuedList The list of linkers to start in this queue (the first is the front)
+   * @param listClass The type of list to create when no queued list is given
+   * @param linkerClass The class used to hold each queued item
+   */
+  constructor (queuedList = null, listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) {
+    this.linkerClass = linkerClass
+    this.queuedList = queuedList === null ? new listClass(linkerClass) : queuedList
+  }
+
+  /**
+   * Take the item from the front of the queue.
+   * @returns The item, or null when the queue is empty
+   */
+  dequeue () {
+    const front = this.queuedList.first
+    if (front === null || typeof front === 'undefined') {
+      return null
+    }
+    this.queuedList.remove(front)
+    return front.data
+  }
+
+  /**
+   * Check whether the queue has no items.
+   */
+  empty () {
+    return this.size() <= 0
+  }
+
+  /**
+   * Add an item to the back of the queue.
+   * @param data The item to add
+   * @returns This queue, so that adding can be chained
+   */
+  enqueue (data) {
+    // The item is wrapped here rather than left to the list, since the list treats objects that look like a linker's
+    // settings (they have a data property) as such, and a queue must give back exactly what it was given
+    this.queuedList.append(new this.linkerClass({
+      data
+    }))
+    return this
+  }
+
+  /**
+   * Look at the item at the front of the queue, without removing it.
+   * @returns The item, or null when the queue is empty
+   */
+  peek () {
+    const front = this.queuedList.first
+    return front === null || typeof front === 'undefined' ? null : front.data
+  }
+
+  /**
+   * Count the items in the queue.
+   */
+  size () {
+    return this.queuedList.length
+  }
+
+  /**
+   * Iterate over the items from the front of the queue to the back, without removing them.
+   */
+  [Symbol.iterator] () {
+    const linkers = this.queuedList[Symbol.iterator]()
+    return {
+      next: () => {
+        const result = linkers.next()
+        return result.done
+          ? {
+              done: true,
+              value: undefined
+            }
+          : {
+              done: false,
+              value: result.value.data
+            }
+      }
+    }
+  }
+}
+/**
+ * Convert an array to a Queue, the first value is at the front.
+ * @param values The items to queue
+ * @param listClass The type of list used to store the items
+ * @param linkerClass The class used to hold each queued item
+ */
+exports.Queue = Queue
+Queue.fromArray = (values = [], listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) => {
+  const queue = new Queue(null, listClass, linkerClass)
+  values.forEach(value => queue.enqueue(value))
+  return queue
+}

package/dist/collections/queue/Queueable.d.ts

@@ -1,8 +1,5 @@
 /**
- * @file queueable item.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
+ * queueable item.
  */
 import { completeResponse, IsRunnable } from '../../recipes/Runnable';
 import { IsLinker } from '../../recipes/IsLinker';
@@ -25,10 +22,10 @@ export declare class Queueable implements IsLinker, IsRunnable {
     running: boolean;
     /**
      * Create a queueable item that can be used in a queue.
-     * @param {Object} [queueableData={}] The settings for the new queueable.
-     * @param {*} [queueableData.task=null] The data to be stored in this queueable
-     * @param {Queueable|null} [queueableData.next=null] The reference to the next queueable if any
-     * @param {boolean|Function} [queueableData.ready=false] Indicate if the queueable is ready to run
+     * @param queueableData The settings for the new queueable.
+     * @param queueableData.task The data to be stored in this queueable
+     * @param queueableData.next The reference to the next queueable if any
+     * @param queueableData.ready Indicate if the queueable is ready to run
      */
     constructor({ task, next, ready }?: {
         task?: any;
@@ -37,21 +34,18 @@ export declare class Queueable implements IsLinker, IsRunnable {
     });
     /**
      * Check ready state.
-     * @return {boolean}
      */
     get isReady(): boolean;
     /**
      * Retrieve the data which should be formed as a task.
-     * @return {*}
      */
     get task(): any;
     /**
      * Set this queueable as completed.
-     * @param {Object} [completeResponse={}] The result to report for the task.
-     * @param {*} [completeResponse.success=true] Indicate when the task failed (use false) or give a success message
-     * @param {*} [completeResponse.error=false] Indicate a task was error-free (use false) or give an error message
-     * @param {*} [completeResponse.context=null] Provide additional data in the response
-     * @return {completeResponse}
+     * @param completeResponse The result to report for the task.
+     * @param completeResponse.success Indicate when the task failed (use false) or give a success message
+     * @param completeResponse.error Indicate a task was error-free (use false) or give an error message
+     * @param completeResponse.context Provide additional data in the response
      */
     markCompleted({ success, error, context }?: {
         success?: any;
@@ -60,21 +54,18 @@ export declare class Queueable implements IsLinker, IsRunnable {
     }): completeResponse;
     /**
      * Intend to run the queued task when it is ready. If ready, mark this task as running and run the task.
-     * @return {completeResponse}
      */
     run(): completeResponse;
     /**
      * Make a new Queueable from the data given if it is not already a valid Queueable.
-     * @param {Queueable|*} queueable Return a valid Queueable instance from given data, or even an already valid one.
-     * @param {IsLinker} [classType=Queueable] Provide the type of IsLinker to use.
-     * @return {Queueable}
+     * @param queueable Return a valid Queueable instance from given data, or even an already valid one.
+     * @param classType Provide the type of IsLinker to use.
      */
     static make: (queueable: Queueable | any, classType?: any) => IsLinker;
     /**
      * Convert an array into Queueable instances, return the head and tail Queueables.
-     * @param {Array} values Provide an array of data that will be converted to a chain of queueable linkers.
-     * @param {IsLinker} [classType=Queueable] Provide the type of IsLinker to use.
-     * @returns {{head: Queueable, tail: Queueable}}
+     * @param values Provide an array of data that will be converted to a chain of queueable linkers.
+     * @param classType Provide the type of IsLinker to use.
      */
     static fromArray: (values?: Array<any>, classType?: any) => {
         head: IsLinker;