collect-your-stuff 1.4.0 → 2.1.0

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

@@ -25,6 +25,8 @@ export declare class LinkedTreeList implements IsTree, Iterable<TreeLinker> {
     private tailCache;
     /** The number of linkers, kept up to date by the list's own methods so that the length does not need to walk the whole list (null when not known yet). */
     private countCache;
+    /** The node these linkers are the children of, remembered so that it is known even while the list is empty (undefined until it is known). */
+    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.
@@ -58,15 +60,17 @@ export declare class LinkedTreeList implements IsTree, Iterable<TreeLinker> {
      */
     get length(): number;
     /**
-     * Get the parent of this tree list.
-     * @return {TreeLinker}
+     * 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;
+    get parent(): TreeLinker | null;
     /**
-     * Set the parent of this tree list
-     * @param {TreeLinker} parent The new node to use as the parent for this group of children
+     * 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
      */
-    set parent(parent: TreeLinker);
+    set parent(parent: TreeLinker | null);
     /**
      * Return the root parent of the entire tree.
      * @return {TreeLinker}
@@ -74,24 +78,31 @@ export declare class LinkedTreeList implements IsTree, Iterable<TreeLinker> {
     get rootParent(): TreeLinker;
     /**
      * 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
+     * @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
+     * @throws {Error} When the item is not one of the linkers of this list
      */
-    setChildren(item: TreeLinker, children?: LinkedTreeList): void;
+    setChildren(item: TreeLinker, children?: LinkedTreeList | null): void;
     /**
-     * Insert a new node (or data) after a node.
-     * @param {TreeLinker|*} node The existing node as reference
+     * 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}
+     */
+    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}
      */
-    insertAfter(node: TreeLinker, newNode: TreeLinker | any): LinkedTreeList;
+    insertAfter(node: TreeLinker | null, newNode: TreeLinker | any): LinkedTreeList;
     /**
-     * Insert a new node (or data) before a node.
-     * @param {TreeLinker|*} node The existing node as reference
+     * 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}
      */
-    insertBefore(node: TreeLinker, newNode: TreeLinker | any): LinkedTreeList;
+    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
@@ -107,11 +118,11 @@ export declare class LinkedTreeList implements IsTree, Iterable<TreeLinker> {
      */
     prepend(node: TreeLinker | any, before?: TreeLinker): LinkedTreeList;
     /**
-     * Remove a linker from this linked list.
+     * 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}
+     * @return {TreeLinker|null} The removed node, or null when there was nothing to remove
      */
-    remove(node: TreeLinker): TreeLinker;
+    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.
@@ -132,7 +143,8 @@ export declare class LinkedTreeList implements IsTree, Iterable<TreeLinker> {
      */
     forEach(callback: forEachCallback, thisArg?: LinkedTreeList): LinkedTreeList;
     /**
-     * Be able to iterate over this class.
+     * 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>;

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

@@ -4,6 +4,8 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.LinkedTreeList = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.for-each.js')
 var _TreeLinker = require('./TreeLinker')
 var _TreeLinkerIterator = require('../../recipes/TreeLinkerIterator')
 var _DoublyLinkedList = require('../doubly-linked-list/DoublyLinkedList')
@@ -41,6 +43,8 @@ class LinkedTreeList {
     this.tailCache = null
     /** The number of linkers, kept up to date by the list's own methods so that the length does not need to walk the whole list (null when not known yet). */
     this.countCache = null
+    /** The node these linkers are the children of, remembered so that it is known even while the list is empty (undefined until it is known). */
+    this.ownerNode = undefined
     this.linkerClass = linkerClass
   }
 
@@ -93,22 +97,25 @@ class LinkedTreeList {
   }
 
   /**
-   * Get the parent of this tree list.
-   * @return {TreeLinker}
+   * 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 () {
-    const first = this.first
-    if (first === null) {
-      return null
+    if (this.ownerNode !== undefined) {
+      return this.ownerNode
     }
-    return this.first.parent
+    const first = this.first
+    return first === null ? null : 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 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
    */
   set parent (parent) {
+    this.ownerNode = parent
     let current = this.first
     while (current !== null) {
       current.parent = parent
@@ -138,34 +145,57 @@ class LinkedTreeList {
 
   /**
    * 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
+   * @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
+   * @throws {Error} When the item is not one of the linkers of this list
    */
   setChildren (item, children = null) {
-    if (Array.from(this).indexOf(item) < 0) {
-      console.error('item is not a child of this')
+    // The item must be one of the linkers of this list (only the siblings are checked, not the whole tree)
+    let isChild = false
+    this.forEach(linker => {
+      if (linker === item) {
+        isChild = true
+      }
+    })
+    if (!isChild) {
+      throw new Error('The item is not one of the linkers of this list.')
+    }
+    if (children === null || typeof children === 'undefined') {
+      item.children = null
+      return
     }
     children.parent = item
   }
 
   /**
-   * Insert a new node (or data) after a node.
-   * @param {TreeLinker|*} node The existing node as reference
+   * 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}
+   */
+  adopt (newNode) {
+    const linker = this.linkerClass.make(newNode, this.linkerClass)
+    linker.parent = this.parent
+    return linker
+  }
+
+  /**
+   * 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}
    */
   insertAfter (node, newNode) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.insertAfter.call(this, node, newNode)
+    return _DoublyLinkedList.DoublyLinkedList.prototype.insertAfter.call(this, node, this.adopt(newNode))
   }
 
   /**
-   * Insert a new node (or data) before a node.
-   * @param {TreeLinker|*} node The existing node as reference
+   * 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}
    */
   insertBefore (node, newNode) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.insertBefore.call(this, node, newNode)
+    return _DoublyLinkedList.DoublyLinkedList.prototype.insertBefore.call(this, node, this.adopt(newNode))
   }
 
   /**
@@ -189,12 +219,19 @@ class LinkedTreeList {
   }
 
   /**
-   * Remove a linker from this linked list.
+   * 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}
+   * @return {TreeLinker|null} The removed node, or null when there was nothing to remove
    */
   remove (node) {
-    return _DoublyLinkedList.DoublyLinkedList.prototype.remove.call(this, node)
+    const owner = this.parent
+    const removed = _DoublyLinkedList.DoublyLinkedList.prototype.remove.call(this, node)
+    if (removed && removed.parent === owner) {
+      // Remember whose children these are (the list may now be empty), the removed node no longer has that parent
+      this.ownerNode = owner
+      removed.parent = null
+    }
+    return removed
   }
 
   /**
@@ -233,12 +270,14 @@ class LinkedTreeList {
   }
 
   /**
-   * Be able to iterate over this class.
+   * 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] () {
-    const root = this.rootParent
-    return new _TreeLinkerIterator.TreeLinkerIterator(root)
+    // 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)
+    return new _TreeLinkerIterator.TreeLinkerIterator(this.first, this.parent)
   }
 }
 /**

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.LinkedTreeList=void 0;var _TreeLinker=require("./TreeLinker"),_TreeLinkerIterator=require("../../recipes/TreeLinkerIterator"),_DoublyLinkedList=require("../doubly-linked-list/DoublyLinkedList");const borrowedGetter=(e,t)=>Object.getOwnPropertyDescriptor(_DoublyLinkedList.DoublyLinkedList.prototype,e).get.call(t);class LinkedTreeList{constructor(e=_TreeLinker.TreeLinker){this.classType=LinkedTreeList,this.innerList=null,this.initialized=!1,this.tailCache=null,this.countCache=null,this.linkerClass=e}initialize(e){return this.initialized?(console.warn("Attempt to initialize LinkedTreeList which is not empty."),this):(this.initialized=!0,this.innerList=e,this)}get list(){return this.innerList}get first(){return borrowedGetter("first",this)}get last(){return borrowedGetter("last",this)}get length(){return borrowedGetter("length",this)}get parent(){return null===this.first?null:this.first.parent}set parent(e){let t=this.first;for(;null!==t;)t.parent=e,t=t.next;e&&(e.children=this)}get rootParent(){let e=this.first;if(!e)return null;let t=this.first.parent;for(;null!==t;)e=t,t=e.parent;return e}setChildren(e,t=null){Array.from(this).indexOf(e)<0&&console.error("item is not a child of this"),t.parent=e}insertAfter(e,t){return _DoublyLinkedList.DoublyLinkedList.prototype.insertAfter.call(this,e,t)}insertBefore(e,t){return _DoublyLinkedList.DoublyLinkedList.prototype.insertBefore.call(this,e,t)}append(e,t=this.last){return _DoublyLinkedList.DoublyLinkedList.prototype.append.call(this,e,t)}prepend(e,t=this.first){return _DoublyLinkedList.DoublyLinkedList.prototype.prepend.call(this,e,t)}remove(e){return _DoublyLinkedList.DoublyLinkedList.prototype.remove.call(this,e)}reset(){return _DoublyLinkedList.DoublyLinkedList.prototype.reset.call(this)}item(e){return _DoublyLinkedList.DoublyLinkedList.prototype.item.call(this,e)}forEach(e,t=this){let r=0,i=t.first;for(;null!==i;)e(i,r,t),i=i.next,++r;return t}[Symbol.iterator](){let e=this.rootParent;return new _TreeLinkerIterator.TreeLinkerIterator(e)}}exports.LinkedTreeList=LinkedTreeList,LinkedTreeList.fromArray=(e=[],t=_TreeLinker.TreeLinker,r=LinkedTreeList)=>new r(t).initialize(t.fromArray(e).head);
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.LinkedTreeList=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.for-each.js");var _TreeLinker=require("./TreeLinker"),_TreeLinkerIterator=require("../../recipes/TreeLinkerIterator"),_DoublyLinkedList=require("../doubly-linked-list/DoublyLinkedList");const borrowedGetter=(e,t)=>Object.getOwnPropertyDescriptor(_DoublyLinkedList.DoublyLinkedList.prototype,e).get.call(t);class LinkedTreeList{constructor(e=_TreeLinker.TreeLinker){this.classType=LinkedTreeList,this.innerList=null,this.initialized=!1,this.tailCache=null,this.countCache=null,this.ownerNode=void 0,this.linkerClass=e}initialize(e){return this.initialized?(console.warn("Attempt to initialize LinkedTreeList which is not empty."),this):(this.initialized=!0,this.innerList=e,this)}get list(){return this.innerList}get first(){return borrowedGetter("first",this)}get last(){return borrowedGetter("last",this)}get length(){return borrowedGetter("length",this)}get parent(){if(void 0!==this.ownerNode)return this.ownerNode;const e=this.first;return null===e?null:e.parent}set parent(e){this.ownerNode=e;let t=this.first;for(;null!==t;)t.parent=e,t=t.next;e&&(e.children=this)}get rootParent(){let e=this.first;if(!e)return null;let t=this.first.parent;for(;null!==t;)e=t,t=e.parent;return e}setChildren(e,t=null){let r=!1;if(this.forEach((t=>{t===e&&(r=!0)})),!r)throw new Error("The item is not one of the linkers of this list.");null!=t?t.parent=e:e.children=null}adopt(e){const t=this.linkerClass.make(e,this.linkerClass);return t.parent=this.parent,t}insertAfter(e,t){return _DoublyLinkedList.DoublyLinkedList.prototype.insertAfter.call(this,e,this.adopt(t))}insertBefore(e,t){return _DoublyLinkedList.DoublyLinkedList.prototype.insertBefore.call(this,e,this.adopt(t))}append(e,t=this.last){return _DoublyLinkedList.DoublyLinkedList.prototype.append.call(this,e,t)}prepend(e,t=this.first){return _DoublyLinkedList.DoublyLinkedList.prototype.prepend.call(this,e,t)}remove(e){const t=this.parent,r=_DoublyLinkedList.DoublyLinkedList.prototype.remove.call(this,e);return r&&r.parent===t&&(this.ownerNode=t,r.parent=null),r}reset(){return _DoublyLinkedList.DoublyLinkedList.prototype.reset.call(this)}item(e){return _DoublyLinkedList.DoublyLinkedList.prototype.item.call(this,e)}forEach(e,t=this){let r=0,i=t.first;for(;null!==i;)e(i,r,t),i=i.next,++r;return t}[Symbol.iterator](){return new _TreeLinkerIterator.TreeLinkerIterator(this.first,this.parent)}}exports.LinkedTreeList=LinkedTreeList,LinkedTreeList.fromArray=(e=[],t=_TreeLinker.TreeLinker,r=LinkedTreeList)=>new r(t).initialize(t.fromArray(e).head);

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

@@ -43,7 +43,9 @@ export declare class TreeLinker implements IsTreeNode {
         listClass?: any;
     });
     /**
-     * Create the children for this tree from an array.
+     * 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}

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

@@ -51,7 +51,9 @@ class TreeLinker {
   }
 
   /**
-   * Create the children for this tree from an array.
+   * 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}
@@ -60,10 +62,17 @@ class TreeLinker {
     if (children === null) {
       return null
     }
-    // Creates a linked-tree-list to store the children.
-    return listClass.fromArray(children.map(child => Object.assign({}, child, {
-      parent: this
-    })), this.classType)
+    // 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
   }
 }
 /**

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TreeLinker=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _DoubleLinker=require("../doubly-linked-list/DoubleLinker"),_LinkedTreeList=require("./LinkedTreeList");class TreeLinker{constructor({data:e=null,next:r=null,prev:i=null,children:n=null,parent:t=null,listClass:l=_LinkedTreeList.LinkedTreeList}={}){this.classType=TreeLinker,this.data=null,this.next=null,this.prev=null,this.parent=null,this.children=null,this.data=e,this.next=r,this.prev=i,this.parent=t,this.children=this.childrenFromArray(n,l)}childrenFromArray(e=null,r=_LinkedTreeList.LinkedTreeList){return null===e?null:r.fromArray(e.map((e=>Object.assign({},e,{parent:this}))),this.classType)}}exports.TreeLinker=TreeLinker,TreeLinker.make=(e,r=TreeLinker)=>_DoubleLinker.DoubleLinker.make(e,r),TreeLinker.fromArray=(e=[],r=TreeLinker)=>_DoubleLinker.DoubleLinker.fromArray(e,r);
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TreeLinker=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _DoubleLinker=require("../doubly-linked-list/DoubleLinker"),_LinkedTreeList=require("./LinkedTreeList");class TreeLinker{constructor({data:e=null,next:r=null,prev:i=null,children:n=null,parent:t=null,listClass:s=_LinkedTreeList.LinkedTreeList}={}){this.classType=TreeLinker,this.data=null,this.next=null,this.prev=null,this.parent=null,this.children=null,this.data=e,this.next=r,this.prev=i,this.parent=t,this.children=this.childrenFromArray(n,s)}childrenFromArray(e=null,r=_LinkedTreeList.LinkedTreeList){if(null===e)return null;const i=e.map((e=>{const r=this.classType.make(e,this.classType);return r.parent=this,r})),n=r.fromArray(i,this.classType);return n.parent=this,n}}exports.TreeLinker=TreeLinker,TreeLinker.make=(e,r=TreeLinker)=>_DoubleLinker.DoubleLinker.make(e,r),TreeLinker.fromArray=(e=[],r=TreeLinker)=>_DoubleLinker.DoubleLinker.fromArray(e,r);

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

@@ -1,66 +1,59 @@
-/**
- * @file queue
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { Queueable } from './Queueable';
+import { Linker } from '../linked-list/Linker';
 import { IsArrayable } from '../../recipes/IsArrayable';
-import { IsLinker } from '../../recipes/IsLinker';
-import { completeResponse } from '../../recipes/Runnable';
+import { IsQueue } from '../../recipes/IsQueue';
 /**
- * Maintain a series of queued items.
+ * 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.
  */
-export declare class Queue {
-    /** The list which stores the queueables, the first is next to be dequeued. */
+export declare class Queue<T = any> implements IsQueue<T>, Iterable<T> {
+    /** The list which stores the queued items, the first is next to be dequeued. */
     queuedList: IsArrayable<any>;
-    private listClass;
-    private queueableClass;
+    private readonly linkerClass;
     /**
-     * Instantiate the queue with the given queue list.
-     * @param {Iterable|LinkedList} queuedList Give the list of queueables to start in this queue.
-     * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no queued list is given.
-     * @param {Queueable} [queueableClass=Queueable] The class used to wrap queued items.
+     * 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?: IsArrayable<any>, listClass?: any, queueableClass?: typeof Queueable);
+    constructor(queuedList?: IsArrayable<any> | null, listClass?: any, linkerClass?: typeof Linker);
     /**
-     * Take a queued task from the front of the queue and run it if ready. A task which is not ready yet is kept in the
-     * queue (never dropped), a task which is still running is reported as blocking and left to finish on its own, and
-     * completed tasks are discarded.
-     * @return {completeResponse|*}
+     * Take the item from the front of the queue.
+     * @return {*|null} The item, or null when the queue is empty
      */
-    dequeue(): completeResponse | any;
+    dequeue(): T | null;
     /**
-     * Return true if the queue is empty (there are no tasks in the queue list)
+     * Check whether the queue has no items.
      * @return {boolean}
      */
     empty(): boolean;
     /**
-     * Add a queued task to the end of the queue
-     * @param {Queueable} queueable Add a new queueable to the end of the queue
-     */
-    enqueue(queueable: Queueable): void;
-    /**
-     * Take a look at the next queued task
-     * @return {Queueable}
+     * 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
      */
-    peek(): IsLinker;
+    enqueue(data: T): this;
     /**
-     * Remove the next queued item and return it.
-     * @return {Queueable|null}
+     * Look at the item at the front of the queue, without removing it.
+     * @return {*|null} The item, or null when the queue is empty
      */
-    remove(): Queueable | null;
+    peek(): T | null;
     /**
-     * Get the length of the current queue.
+     * Count the items in the queue.
      * @return {number}
      */
     size(): number;
     /**
-     * Convert an array to a Queue.
-     * @param {Array} values An array of values which will be converted to queueables in this queue
-     * @param {Queueable} queueableClass The class to use for each queueable
-     * @param {Queue|Iterable} listClass The class to use to manage the queueables
+     * 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}
      */
-    static fromArray: (values?: Array<any>, queueableClass?: typeof Queueable, listClass?: any) => Queue;
+    static fromArray: <T_1 = any>(values?: Array<T_1>, listClass?: any, linkerClass?: typeof Linker) => Queue<T_1>;
 }

package/dist/collections/queue/Queue.js

@@ -4,81 +4,49 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.Queue = void 0
-var _Queueable = require('./Queueable')
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.for-each.js')
 var _LinkedList = require('../linked-list/LinkedList')
+var _Linker = require('../linked-list/Linker')
 /**
  * @file queue
  * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
+ * @version 2.0.0
  * @memberOf module:collect-your-stuff
  */
 
 /**
- * Maintain a series of queued items.
+ * 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 with the given queue list.
-   * @param {Iterable|LinkedList} queuedList Give the list of queueables to start in this queue.
-   * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no queued list is given.
-   * @param {Queueable} [queueableClass=Queueable] The class used to wrap queued items.
+   * 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, queueableClass = _Queueable.Queueable) {
-    this.listClass = listClass
-    this.queueableClass = queueableClass
-    if (queuedList === null) {
-      queuedList = new listClass(queueableClass)
-    }
-    this.queuedList = queuedList
+  constructor (queuedList = null, listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) {
+    this.linkerClass = linkerClass
+    this.queuedList = queuedList === null ? new listClass(linkerClass) : queuedList
   }
 
   /**
-   * Take a queued task from the front of the queue and run it if ready. A task which is not ready yet is kept in the
-   * queue (never dropped), a task which is still running is reported as blocking and left to finish on its own, and
-   * completed tasks are discarded.
-   * @return {completeResponse|*}
+   * Take the item from the front of the queue.
+   * @return {*|null} The item, or null when the queue is empty
    */
   dequeue () {
-    let next = this.remove()
-    // Tasks which already completed are discarded when they reach the front of the queue
-    while (next && next.complete) {
-      next = this.remove()
-    }
-    if (!next) {
-      return {
-        success: 'No more queueable tasks in the queue',
-        error: false,
-        context: this.queuedList
-      }
-    }
-    if (next.running) {
-      // The unfinished task reports back through its own complete callback, so it is not kept in the queue
-      return {
-        success: false,
-        error: 'The queue has been blocked by an unfinished task.',
-        context: next
-      }
-    }
-    if (!next.isReady) {
-      // Keep the task (at the back, so the next dequeue can try the other tasks) rather than losing it
-      this.enqueue(next)
-      // We could go check the next in queue here but if we end up in a state where nothing is ready it would infinite loop
-      // Also, we want the loop handled externally
-      return {
-        success: false,
-        error: 'Unable to find ready task.',
-        context: next
-      }
-    }
-    if (!this.empty()) {
-      // Place back in queue to be checked once again next time, only if the queue will not be empty
-      this.enqueue(next)
+    const front = this.queuedList.first
+    if (front === null || typeof front === 'undefined') {
+      return null
     }
-    return next.run.call(next)
+    this.queuedList.remove(front)
+    return front.data
   }
 
   /**
-   * Return true if the queue is empty (there are no tasks in the queue list)
+   * Check whether the queue has no items.
    * @return {boolean}
    */
   empty () {
@@ -86,50 +54,66 @@ class Queue {
   }
 
   /**
-   * Add a queued task to the end of the queue
-   * @param {Queueable} queueable Add a new queueable to the end of the queue
+   * 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 (queueable) {
-    this.queuedList.append(queueable)
+  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
   }
 
   /**
-   * Take a look at the next queued task
-   * @return {Queueable}
+   * 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 () {
-    return this.queuedList.first
+    const front = this.queuedList.first
+    return front === null || typeof front === 'undefined' ? null : front.data
   }
 
   /**
-   * Remove the next queued item and return it.
-   * @return {Queueable|null}
+   * Count the items in the queue.
+   * @return {number}
    */
-  remove () {
-    if (this.empty()) {
-      return null
-    }
-    return this.queuedList.remove(this.queuedList.first)
+  size () {
+    return this.queuedList.length
   }
 
   /**
-   * Get the length of the current queue.
-   * @return {number}
+   * Iterate over the items from the front of the queue to the back, without removing them.
+   * @return {Iterator}
    */
-  size () {
-    return this.queuedList.length
+  [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.
- * @param {Array} values An array of values which will be converted to queueables in this queue
- * @param {Queueable} queueableClass The class to use for each queueable
- * @param {Queue|Iterable} listClass The class to use to manage the queueables
+ * 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 = [], queueableClass = _Queueable.Queueable, listClass = _LinkedList.LinkedList) => {
-  const list = new listClass(queueableClass)
-  list.initialize(queueableClass.fromArray(values, queueableClass).head)
-  return new Queue(list, listClass, queueableClass)
+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/Queue.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Queue=void 0;var _Queueable=require("./Queueable"),_LinkedList=require("../linked-list/LinkedList");class Queue{constructor(e=null,u=_LinkedList.LinkedList,t=_Queueable.Queueable){this.listClass=u,this.queueableClass=t,null===e&&(e=new u(t)),this.queuedList=e}dequeue(){let e=this.remove();for(;e&&e.complete;)e=this.remove();return e?e.running?{success:!1,error:"The queue has been blocked by an unfinished task.",context:e}:e.isReady?(this.empty()||this.enqueue(e),e.run.call(e)):(this.enqueue(e),{success:!1,error:"Unable to find ready task.",context:e}):{success:"No more queueable tasks in the queue",error:!1,context:this.queuedList}}empty(){return this.size()<=0}enqueue(e){this.queuedList.append(e)}peek(){return this.queuedList.first}remove(){return this.empty()?null:this.queuedList.remove(this.queuedList.first)}size(){return this.queuedList.length}}exports.Queue=Queue,Queue.fromArray=(e=[],u=_Queueable.Queueable,t=_LinkedList.LinkedList)=>{const s=new t(u);return s.initialize(u.fromArray(e,u).head),new Queue(s,t,u)};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Queue=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.for-each.js");var _LinkedList=require("../linked-list/LinkedList"),_Linker=require("../linked-list/Linker");class Queue{constructor(e=null,t=_LinkedList.LinkedList,r=_Linker.Linker){this.linkerClass=r,this.queuedList=null===e?new t(r):e}dequeue(){const e=this.queuedList.first;return null==e?null:(this.queuedList.remove(e),e.data)}empty(){return this.size()<=0}enqueue(e){return this.queuedList.append(new this.linkerClass({data:e})),this}peek(){const e=this.queuedList.first;return null==e?null:e.data}size(){return this.queuedList.length}[Symbol.iterator](){const e=this.queuedList[Symbol.iterator]();return{next:()=>{const t=e.next();return t.done?{done:!0,value:void 0}:{done:!1,value:t.value.data}}}}}exports.Queue=Queue,Queue.fromArray=(e=[],t=_LinkedList.LinkedList,r=_Linker.Linker)=>{const u=new Queue(null,t,r);return e.forEach((e=>u.enqueue(e))),u};