collect-your-stuff 1.3.2 → 2.0.0

package/dist/collections/stack/Stack.d.ts

@@ -1,64 +1,64 @@
-/**
- * @file stack.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
- */
-import { Stackable } from './Stackable';
+import { Linker } from '../linked-list/Linker';
 import { IsArrayable } from '../../recipes/IsArrayable';
-import { IsLinker } from '../../recipes/IsLinker';
-import { completeResponse } from '../../recipes/Runnable';
+import { IsStack } from '../../recipes/IsStack';
 /**
- * Store a collection of items which can only be inserted and removed from the top.
+ * A last-in-first-out collection: items are added to the top with push and taken from the top with pop. Any value can
+ * be stacked (it is stored as it is, whether it is a function, an object or null), and adding and taking are constant
+ * time. To stack tasks which are run as they are taken use TaskStack.
  */
-export declare class Stack {
-    /** The list which stores the stackables, the first is the top of the stack. */
+export declare class Stack<T = any> implements IsStack<T>, Iterable<T> {
+    /** The list which stores the stacked items, the first is the top of the stack. */
     stackedList: IsArrayable<any>;
-    private listClass;
-    private stackableClass;
+    private readonly linkerClass;
     /**
-     * Instantiate the state with the starter stacked list.
-     * @param {Iterable|LinkedList} [stackedList=null] The list of stackables to start in this stack.
-     * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no stacked list is given.
-     * @param {Stackable} [stackableClass=Stackable] The class used to wrap stacked items.
+     * Instantiate the stack, optionally with a list of items to start from.
+     * @param {IsArrayable|null} [stackedList=null] The list of linkers to start in this stack (the first is the top)
+     * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no stacked list is given
+     * @param {Linker} [linkerClass=Linker] The class used to hold each stacked item
      */
-    constructor(stackedList?: IsArrayable<any>, listClass?: any, stackableClass?: typeof Stackable);
+    constructor(stackedList?: IsArrayable<any> | null, listClass?: any, linkerClass?: typeof Linker);
     /**
-     * Return true if the stack is empty (there are no tasks in the stacked list)
+     * Check whether the stack has no items.
      * @return {boolean}
      */
     empty(): boolean;
     /**
-     * Take a look at the next stacked task
-     * @return {Stackable}
-     */
-    top(): IsLinker;
-    /**
-     * Remove the next stacked task and return it.
-     * @return {Stackable|null}
+     * Look at the item on the top of the stack, without removing it.
+     * @return {*|null} The item, or null when the stack is empty
      */
-    pop(): Stackable | completeResponse | null;
+    peek(): T | null;
     /**
-     * Push a stackable task to the top of the stack.
-     * @param {Stackable|*} stackable Add a new stackable to the top of the stack
+     * Take the item from the top of the stack.
+     * @return {*|null} The item, or null when the stack is empty
      */
-    push(stackable: any): void;
+    pop(): T | null;
     /**
-     * Remove the next stacked task and return it.
-     * @return {Stackable|null}
+     * Add an item to the top of the stack.
+     * @param {*} data The item to add
+     * @return {Stack} This stack, so that adding can be chained
      */
-    remove(): Stackable | null;
+    push(data: T): this;
     /**
-     * Get the size of the current stack.
+     * Count the items in the stack.
      * @return {number}
      */
     size(): number;
     /**
-     * Convert an array to a Stack.
-     * @param {Array} values An array of values which will be converted to stackables in this queue
-     * @param {Stackable} stackableClass The class to use for each stackable
-     * @param {Stack|Iterable} listClass The class to use to manage the stackables
+     * The item on the top of the stack (the same as peek).
+     * @return {*|null} The item, or null when the stack is empty
+     */
+    top(): T | null;
+    /**
+     * Iterate over the items from the top of the stack to the bottom, without removing them.
+     * @return {Iterator}
+     */
+    [Symbol.iterator](): Iterator<T>;
+    /**
+     * Convert an array to a Stack by pushing each value in turn, so the last value is on the top.
+     * @param {Array} [values=[]] The items to stack
+     * @param {IsArrayable} [listClass=LinkedList] The type of list used to store the items
+     * @param {Linker} [linkerClass=Linker] The class used to hold each stacked item
      * @returns {Stack}
      */
-    static fromArray: (values?: Array<any>, stackableClass?: typeof Stackable, listClass?: any) => Stack;
+    static fromArray: <T_1 = any>(values?: Array<T_1>, listClass?: any, linkerClass?: typeof Linker) => Stack<T_1>;
 }

package/dist/collections/stack/Stack.js

@@ -4,36 +4,36 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.Stack = void 0
-var _Stackable = require('./Stackable')
+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 stack.
  * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * @version 2.0.0
  * @memberOf module:collect-your-stuff
  */
 
 /**
- * Store a collection of items which can only be inserted and removed from the top.
+ * A last-in-first-out collection: items are added to the top with push and taken from the top with pop. Any value can
+ * be stacked (it is stored as it is, whether it is a function, an object or null), and adding and taking are constant
+ * time. To stack tasks which are run as they are taken use TaskStack.
  */
 class Stack {
   /**
-   * Instantiate the state with the starter stacked list.
-   * @param {Iterable|LinkedList} [stackedList=null] The list of stackables to start in this stack.
-   * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no stacked list is given.
-   * @param {Stackable} [stackableClass=Stackable] The class used to wrap stacked items.
+   * Instantiate the stack, optionally with a list of items to start from.
+   * @param {IsArrayable|null} [stackedList=null] The list of linkers to start in this stack (the first is the top)
+   * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no stacked list is given
+   * @param {Linker} [linkerClass=Linker] The class used to hold each stacked item
    */
-  constructor (stackedList = null, listClass = _LinkedList.LinkedList, stackableClass = _Stackable.Stackable) {
-    this.listClass = listClass
-    this.stackableClass = stackableClass
-    if (stackedList === null) {
-      stackedList = new listClass(stackableClass)
-    }
-    this.stackedList = stackedList
+  constructor (stackedList = null, listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) {
+    this.linkerClass = linkerClass
+    this.stackedList = stackedList === null ? new listClass(linkerClass) : stackedList
   }
 
   /**
-   * Return true if the stack is empty (there are no tasks in the stacked list)
+   * Check whether the stack has no items.
    * @return {boolean}
    */
   empty () {
@@ -41,66 +41,87 @@ class Stack {
   }
 
   /**
-   * Take a look at the next stacked task
-   * @return {Stackable}
+   * Look at the item on the top of the stack, without removing it.
+   * @return {*|null} The item, or null when the stack is empty
    */
-  top () {
-    return this.stackedList.first
+  peek () {
+    const top = this.stackedList.first
+    return top === null || typeof top === 'undefined' ? null : top.data
   }
 
   /**
-   * Remove the next stacked task and return it.
-   * @return {Stackable|null}
+   * Take the item from the top of the stack.
+   * @return {*|null} The item, or null when the stack is empty
    */
   pop () {
-    const next = this.remove()
-    if (!next) {
-      return {
-        success: 'No more stackable tasks in the stack',
-        error: false,
-        context: this.stackedList
-      }
+    const top = this.stackedList.first
+    if (top === null || typeof top === 'undefined') {
+      return null
     }
-    return next.run()
+    this.stackedList.remove(top)
+    return top.data
   }
 
   /**
-   * Push a stackable task to the top of the stack.
-   * @param {Stackable|*} stackable Add a new stackable to the top of the stack
+   * Add an item to the top of the stack.
+   * @param {*} data The item to add
+   * @return {Stack} This stack, so that adding can be chained
    */
-  push (stackable) {
-    this.stackedList.prepend(stackable)
+  push (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 stack must give back exactly what it was given
+    this.stackedList.prepend(new this.linkerClass({
+      data
+    }))
+    return this
   }
 
   /**
-   * Remove the next stacked task and return it.
-   * @return {Stackable|null}
+   * Count the items in the stack.
+   * @return {number}
    */
-  remove () {
-    if (this.empty()) {
-      return null
-    }
-    return this.stackedList.remove(this.stackedList.first)
+  size () {
+    return this.stackedList.length
   }
 
   /**
-   * Get the size of the current stack.
-   * @return {number}
+   * The item on the top of the stack (the same as peek).
+   * @return {*|null} The item, or null when the stack is empty
    */
-  size () {
-    return this.stackedList.length
+  top () {
+    return this.peek()
+  }
+
+  /**
+   * Iterate over the items from the top of the stack to the bottom, without removing them.
+   * @return {Iterator}
+   */
+  [Symbol.iterator] () {
+    const linkers = this.stackedList[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 Stack.
- * @param {Array} values An array of values which will be converted to stackables in this queue
- * @param {Stackable} stackableClass The class to use for each stackable
- * @param {Stack|Iterable} listClass The class to use to manage the stackables
+ * Convert an array to a Stack by pushing each value in turn, so the last value is on the top.
+ * @param {Array} [values=[]] The items to stack
+ * @param {IsArrayable} [listClass=LinkedList] The type of list used to store the items
+ * @param {Linker} [linkerClass=Linker] The class used to hold each stacked item
  * @returns {Stack}
  */
 exports.Stack = Stack
-Stack.fromArray = (values = [], stackableClass = _Stackable.Stackable, listClass = _LinkedList.LinkedList) => {
-  const list = new listClass(stackableClass)
-  list.initialize(stackableClass.fromArray(values, stackableClass).head)
-  return new Stack(list, listClass, stackableClass)
+Stack.fromArray = (values = [], listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) => {
+  const stack = new Stack(null, listClass, linkerClass)
+  values.forEach(value => stack.push(value))
+  return stack
 }

package/dist/collections/stack/Stack.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Stack=void 0;var _Stackable=require("./Stackable"),_LinkedList=require("../linked-list/LinkedList");class Stack{constructor(t=null,e=_LinkedList.LinkedList,s=_Stackable.Stackable){this.listClass=e,this.stackableClass=s,null===t&&(t=new e(s)),this.stackedList=t}empty(){return this.size()<=0}top(){return this.stackedList.first}pop(){const t=this.remove();return t?t.run():{success:"No more stackable tasks in the stack",error:!1,context:this.stackedList}}push(t){this.stackedList.prepend(t)}remove(){return this.empty()?null:this.stackedList.remove(this.stackedList.first)}size(){return this.stackedList.length}}exports.Stack=Stack,Stack.fromArray=(t=[],e=_Stackable.Stackable,s=_LinkedList.LinkedList)=>{const i=new s(e);return i.initialize(e.fromArray(t,e).head),new Stack(i,s,e)};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Stack=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 Stack{constructor(e=null,t=_LinkedList.LinkedList,s=_Linker.Linker){this.linkerClass=s,this.stackedList=null===e?new t(s):e}empty(){return this.size()<=0}peek(){const e=this.stackedList.first;return null==e?null:e.data}pop(){const e=this.stackedList.first;return null==e?null:(this.stackedList.remove(e),e.data)}push(e){return this.stackedList.prepend(new this.linkerClass({data:e})),this}size(){return this.stackedList.length}top(){return this.peek()}[Symbol.iterator](){const e=this.stackedList[Symbol.iterator]();return{next:()=>{const t=e.next();return t.done?{done:!0,value:void 0}:{done:!1,value:t.value.data}}}}}exports.Stack=Stack,Stack.fromArray=(e=[],t=_LinkedList.LinkedList,s=_Linker.Linker)=>{const r=new Stack(null,t,s);return e.forEach((e=>r.push(e))),r};

package/dist/collections/stack/TaskStack.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @file task stack.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @memberOf module:collect-your-stuff
+ */
+import { Stackable } from './Stackable';
+import { IsArrayable } from '../../recipes/IsArrayable';
+import { IsLinker } from '../../recipes/IsLinker';
+import { completeResponse } from '../../recipes/Runnable';
+/**
+ * Store a collection of tasks (Stackables) which can only be inserted and removed from the top: pop() takes the task from
+ * the top and RUNS it. For a plain last-in-first-out collection of items use Stack.
+ */
+export declare class TaskStack {
+    /** The list which stores the stackables, the first is the top of the stack. */
+    stackedList: IsArrayable<any>;
+    private listClass;
+    private stackableClass;
+    /**
+     * Instantiate the state with the starter stacked list.
+     * @param {Iterable|LinkedList} [stackedList=null] The list of stackables to start in this stack.
+     * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no stacked list is given.
+     * @param {Stackable} [stackableClass=Stackable] The class used to wrap stacked items.
+     */
+    constructor(stackedList?: IsArrayable<any>, listClass?: any, stackableClass?: typeof Stackable);
+    /**
+     * Return true if the stack is empty (there are no tasks in the stacked list)
+     * @return {boolean}
+     */
+    empty(): boolean;
+    /**
+     * Take a look at the next stacked task
+     * @return {Stackable}
+     */
+    top(): IsLinker;
+    /**
+     * Remove the next stacked task and return it.
+     * @return {Stackable|null}
+     */
+    pop(): Stackable | completeResponse | null;
+    /**
+     * Push a stackable task to the top of the stack.
+     * @param {Stackable|*} stackable Add a new stackable to the top of the stack
+     */
+    push(stackable: any): void;
+    /**
+     * Remove the next stacked task and return it.
+     * @return {Stackable|null}
+     */
+    remove(): Stackable | null;
+    /**
+     * Get the size of the current stack.
+     * @return {number}
+     */
+    size(): number;
+    /**
+     * Convert an array to a TaskStack.
+     * @param {Array} values An array of values which will be converted to stackables in this queue
+     * @param {Stackable} stackableClass The class to use for each stackable
+     * @param {TaskStack|Iterable} listClass The class to use to manage the stackables
+     * @returns {TaskStack}
+     */
+    static fromArray: (values?: Array<any>, stackableClass?: typeof Stackable, listClass?: any) => TaskStack;
+}

package/dist/collections/stack/TaskStack.js

@@ -0,0 +1,107 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.TaskStack = void 0
+var _Stackable = require('./Stackable')
+var _LinkedList = require('../linked-list/LinkedList')
+/**
+ * @file task stack.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @memberOf module:collect-your-stuff
+ */
+
+/**
+ * Store a collection of tasks (Stackables) which can only be inserted and removed from the top: pop() takes the task from
+ * the top and RUNS it. For a plain last-in-first-out collection of items use Stack.
+ */
+class TaskStack {
+  /**
+   * Instantiate the state with the starter stacked list.
+   * @param {Iterable|LinkedList} [stackedList=null] The list of stackables to start in this stack.
+   * @param {IsArrayable} [listClass=LinkedList] The type of list to create when no stacked list is given.
+   * @param {Stackable} [stackableClass=Stackable] The class used to wrap stacked items.
+   */
+  constructor (stackedList = null, listClass = _LinkedList.LinkedList, stackableClass = _Stackable.Stackable) {
+    this.listClass = listClass
+    this.stackableClass = stackableClass
+    if (stackedList === null) {
+      stackedList = new listClass(stackableClass)
+    }
+    this.stackedList = stackedList
+  }
+
+  /**
+   * Return true if the stack is empty (there are no tasks in the stacked list)
+   * @return {boolean}
+   */
+  empty () {
+    return this.size() <= 0
+  }
+
+  /**
+   * Take a look at the next stacked task
+   * @return {Stackable}
+   */
+  top () {
+    return this.stackedList.first
+  }
+
+  /**
+   * Remove the next stacked task and return it.
+   * @return {Stackable|null}
+   */
+  pop () {
+    const next = this.remove()
+    if (!next) {
+      return {
+        success: 'No more stackable tasks in the stack',
+        error: false,
+        context: this.stackedList
+      }
+    }
+    return next.run()
+  }
+
+  /**
+   * Push a stackable task to the top of the stack.
+   * @param {Stackable|*} stackable Add a new stackable to the top of the stack
+   */
+  push (stackable) {
+    this.stackedList.prepend(stackable)
+  }
+
+  /**
+   * Remove the next stacked task and return it.
+   * @return {Stackable|null}
+   */
+  remove () {
+    if (this.empty()) {
+      return null
+    }
+    return this.stackedList.remove(this.stackedList.first)
+  }
+
+  /**
+   * Get the size of the current stack.
+   * @return {number}
+   */
+  size () {
+    return this.stackedList.length
+  }
+}
+/**
+ * Convert an array to a TaskStack.
+ * @param {Array} values An array of values which will be converted to stackables in this queue
+ * @param {Stackable} stackableClass The class to use for each stackable
+ * @param {TaskStack|Iterable} listClass The class to use to manage the stackables
+ * @returns {TaskStack}
+ */
+exports.TaskStack = TaskStack
+TaskStack.fromArray = (values = [], stackableClass = _Stackable.Stackable, listClass = _LinkedList.LinkedList) => {
+  const list = new listClass(stackableClass)
+  list.initialize(stackableClass.fromArray(values, stackableClass).head)
+  return new TaskStack(list, listClass, stackableClass)
+}

package/dist/collections/stack/TaskStack.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TaskStack=void 0;var _Stackable=require("./Stackable"),_LinkedList=require("../linked-list/LinkedList");class TaskStack{constructor(t=null,s=_LinkedList.LinkedList,e=_Stackable.Stackable){this.listClass=s,this.stackableClass=e,null===t&&(t=new s(e)),this.stackedList=t}empty(){return this.size()<=0}top(){return this.stackedList.first}pop(){const t=this.remove();return t?t.run():{success:"No more stackable tasks in the stack",error:!1,context:this.stackedList}}push(t){this.stackedList.prepend(t)}remove(){return this.empty()?null:this.stackedList.remove(this.stackedList.first)}size(){return this.stackedList.length}}exports.TaskStack=TaskStack,TaskStack.fromArray=(t=[],s=_Stackable.Stackable,e=_LinkedList.LinkedList)=>{const i=new e(s);return i.initialize(s.fromArray(t,s).head),new TaskStack(i,e,s)};

package/dist/main.d.ts

@@ -16,8 +16,10 @@ import { TreeLinker } from './collections/linked-tree-list/TreeLinker';
 import { LinkedTreeList } from './collections/linked-tree-list/LinkedTreeList';
 import { Queueable } from './collections/queue/Queueable';
 import { Queue } from './collections/queue/Queue';
+import { TaskQueue } from './collections/queue/TaskQueue';
 import { Stackable } from './collections/stack/Stackable';
 import { Stack } from './collections/stack/Stack';
+import { TaskStack } from './collections/stack/TaskStack';
 import { recipes } from './recipes/recipes';
 import { services } from './services/services';
 /**
@@ -26,13 +28,15 @@ import { services } from './services/services';
  * 2. Create a heap (both min and max heap variants) which is similar to binary tree in structure, but tree having its min / max value as root. and it must insert on the left-most lowest level, and removes from root. Be able to easily swap nodes to ensure min / max ordering.
  * 3. Create a graph type which can have directional and undirectional variants for linking nodes
  */
-export { ArrayElement, Arrayable, DoubleLinker, DoublyLinkedList, Linker, LinkedList, TreeLinker, LinkedTreeList, Queueable, Queue, Stackable, Stack, recipes, services };
+export { ArrayElement, Arrayable, DoubleLinker, DoublyLinkedList, Linker, LinkedList, TreeLinker, LinkedTreeList, Queueable, Queue, TaskQueue, Stackable, Stack, TaskStack, recipes, services };
 export type { IsArrayable, forEachCallback } from './recipes/IsArrayable';
 export type { IsDoubleLinker } from './recipes/IsDoubleLinker';
 export type { IsElement } from './recipes/IsElement';
 export type { IsLinker } from './recipes/IsLinker';
 export type { IsTree } from './recipes/IsTree';
 export type { IsTreeNode } from './recipes/IsTreeNode';
+export type { IsQueue } from './recipes/IsQueue';
+export type { IsStack } from './recipes/IsStack';
 export type { IsRunnable, completeResponse } from './recipes/Runnable';
 /**
  * All methods exported from this module are encapsulated within collect-your-stuff (this default export is the same
@@ -49,8 +53,10 @@ declare const collectYourStuff: {
     LinkedTreeList: typeof LinkedTreeList;
     Queueable: typeof Queueable;
     Queue: typeof Queue;
+    TaskQueue: typeof TaskQueue;
     Stackable: typeof Stackable;
     Stack: typeof Stack;
+    TaskStack: typeof TaskStack;
     recipes: {
         ArrayIterator: typeof import("./recipes/ArrayIterator").ArrayIterator;
         Runnable: typeof import("./recipes/Runnable").Runnable;

package/dist/main.js

@@ -69,6 +69,18 @@ Object.defineProperty(exports, 'Stackable', {
     return _Stackable.Stackable
   }
 })
+Object.defineProperty(exports, 'TaskQueue', {
+  enumerable: true,
+  get: function () {
+    return _TaskQueue.TaskQueue
+  }
+})
+Object.defineProperty(exports, 'TaskStack', {
+  enumerable: true,
+  get: function () {
+    return _TaskStack.TaskStack
+  }
+})
 Object.defineProperty(exports, 'TreeLinker', {
   enumerable: true,
   get: function () {
@@ -99,8 +111,10 @@ var _TreeLinker = require('./collections/linked-tree-list/TreeLinker')
 var _LinkedTreeList = require('./collections/linked-tree-list/LinkedTreeList')
 var _Queueable = require('./collections/queue/Queueable')
 var _Queue = require('./collections/queue/Queue')
+var _TaskQueue = require('./collections/queue/TaskQueue')
 var _Stackable = require('./collections/stack/Stackable')
 var _Stack = require('./collections/stack/Stack')
+var _TaskStack = require('./collections/stack/TaskStack')
 var _recipes = require('./recipes/recipes')
 var _services = require('./services/services')
 /**
@@ -135,8 +149,10 @@ const collectYourStuff = {
   LinkedTreeList: _LinkedTreeList.LinkedTreeList,
   Queueable: _Queueable.Queueable,
   Queue: _Queue.Queue,
+  TaskQueue: _TaskQueue.TaskQueue,
   Stackable: _Stackable.Stackable,
   Stack: _Stack.Stack,
+  TaskStack: _TaskStack.TaskStack,
   recipes: _recipes.recipes,
   services: _services.services
 }

package/dist/main.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"ArrayElement",{enumerable:!0,get:function(){return _ArrayElement.ArrayElement}}),Object.defineProperty(exports,"Arrayable",{enumerable:!0,get:function(){return _Arrayable.Arrayable}}),Object.defineProperty(exports,"DoubleLinker",{enumerable:!0,get:function(){return _DoubleLinker.DoubleLinker}}),Object.defineProperty(exports,"DoublyLinkedList",{enumerable:!0,get:function(){return _DoublyLinkedList.DoublyLinkedList}}),Object.defineProperty(exports,"LinkedList",{enumerable:!0,get:function(){return _LinkedList.LinkedList}}),Object.defineProperty(exports,"LinkedTreeList",{enumerable:!0,get:function(){return _LinkedTreeList.LinkedTreeList}}),Object.defineProperty(exports,"Linker",{enumerable:!0,get:function(){return _Linker.Linker}}),Object.defineProperty(exports,"Queue",{enumerable:!0,get:function(){return _Queue.Queue}}),Object.defineProperty(exports,"Queueable",{enumerable:!0,get:function(){return _Queueable.Queueable}}),Object.defineProperty(exports,"Stack",{enumerable:!0,get:function(){return _Stack.Stack}}),Object.defineProperty(exports,"Stackable",{enumerable:!0,get:function(){return _Stackable.Stackable}}),Object.defineProperty(exports,"TreeLinker",{enumerable:!0,get:function(){return _TreeLinker.TreeLinker}}),exports.default=void 0,Object.defineProperty(exports,"recipes",{enumerable:!0,get:function(){return _recipes.recipes}}),Object.defineProperty(exports,"services",{enumerable:!0,get:function(){return _services.services}}),require("core-js/stable");var _ArrayElement=require("./collections/arrayable/ArrayElement"),_Arrayable=require("./collections/arrayable/Arrayable"),_DoubleLinker=require("./collections/doubly-linked-list/DoubleLinker"),_DoublyLinkedList=require("./collections/doubly-linked-list/DoublyLinkedList"),_Linker=require("./collections/linked-list/Linker"),_LinkedList=require("./collections/linked-list/LinkedList"),_TreeLinker=require("./collections/linked-tree-list/TreeLinker"),_LinkedTreeList=require("./collections/linked-tree-list/LinkedTreeList"),_Queueable=require("./collections/queue/Queueable"),_Queue=require("./collections/queue/Queue"),_Stackable=require("./collections/stack/Stackable"),_Stack=require("./collections/stack/Stack"),_recipes=require("./recipes/recipes"),_services=require("./services/services");const collectYourStuff={ArrayElement:_ArrayElement.ArrayElement,Arrayable:_Arrayable.Arrayable,DoubleLinker:_DoubleLinker.DoubleLinker,DoublyLinkedList:_DoublyLinkedList.DoublyLinkedList,Linker:_Linker.Linker,LinkedList:_LinkedList.LinkedList,TreeLinker:_TreeLinker.TreeLinker,LinkedTreeList:_LinkedTreeList.LinkedTreeList,Queueable:_Queueable.Queueable,Queue:_Queue.Queue,Stackable:_Stackable.Stackable,Stack:_Stack.Stack,recipes:_recipes.recipes,services:_services.services};var _default=exports.default=collectYourStuff;"undefined"!=typeof window&&(window.collectYourStuff=collectYourStuff);
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"ArrayElement",{enumerable:!0,get:function(){return _ArrayElement.ArrayElement}}),Object.defineProperty(exports,"Arrayable",{enumerable:!0,get:function(){return _Arrayable.Arrayable}}),Object.defineProperty(exports,"DoubleLinker",{enumerable:!0,get:function(){return _DoubleLinker.DoubleLinker}}),Object.defineProperty(exports,"DoublyLinkedList",{enumerable:!0,get:function(){return _DoublyLinkedList.DoublyLinkedList}}),Object.defineProperty(exports,"LinkedList",{enumerable:!0,get:function(){return _LinkedList.LinkedList}}),Object.defineProperty(exports,"LinkedTreeList",{enumerable:!0,get:function(){return _LinkedTreeList.LinkedTreeList}}),Object.defineProperty(exports,"Linker",{enumerable:!0,get:function(){return _Linker.Linker}}),Object.defineProperty(exports,"Queue",{enumerable:!0,get:function(){return _Queue.Queue}}),Object.defineProperty(exports,"Queueable",{enumerable:!0,get:function(){return _Queueable.Queueable}}),Object.defineProperty(exports,"Stack",{enumerable:!0,get:function(){return _Stack.Stack}}),Object.defineProperty(exports,"Stackable",{enumerable:!0,get:function(){return _Stackable.Stackable}}),Object.defineProperty(exports,"TaskQueue",{enumerable:!0,get:function(){return _TaskQueue.TaskQueue}}),Object.defineProperty(exports,"TaskStack",{enumerable:!0,get:function(){return _TaskStack.TaskStack}}),Object.defineProperty(exports,"TreeLinker",{enumerable:!0,get:function(){return _TreeLinker.TreeLinker}}),exports.default=void 0,Object.defineProperty(exports,"recipes",{enumerable:!0,get:function(){return _recipes.recipes}}),Object.defineProperty(exports,"services",{enumerable:!0,get:function(){return _services.services}}),require("core-js/stable");var _ArrayElement=require("./collections/arrayable/ArrayElement"),_Arrayable=require("./collections/arrayable/Arrayable"),_DoubleLinker=require("./collections/doubly-linked-list/DoubleLinker"),_DoublyLinkedList=require("./collections/doubly-linked-list/DoublyLinkedList"),_Linker=require("./collections/linked-list/Linker"),_LinkedList=require("./collections/linked-list/LinkedList"),_TreeLinker=require("./collections/linked-tree-list/TreeLinker"),_LinkedTreeList=require("./collections/linked-tree-list/LinkedTreeList"),_Queueable=require("./collections/queue/Queueable"),_Queue=require("./collections/queue/Queue"),_TaskQueue=require("./collections/queue/TaskQueue"),_Stackable=require("./collections/stack/Stackable"),_Stack=require("./collections/stack/Stack"),_TaskStack=require("./collections/stack/TaskStack"),_recipes=require("./recipes/recipes"),_services=require("./services/services");const collectYourStuff={ArrayElement:_ArrayElement.ArrayElement,Arrayable:_Arrayable.Arrayable,DoubleLinker:_DoubleLinker.DoubleLinker,DoublyLinkedList:_DoublyLinkedList.DoublyLinkedList,Linker:_Linker.Linker,LinkedList:_LinkedList.LinkedList,TreeLinker:_TreeLinker.TreeLinker,LinkedTreeList:_LinkedTreeList.LinkedTreeList,Queueable:_Queueable.Queueable,Queue:_Queue.Queue,TaskQueue:_TaskQueue.TaskQueue,Stackable:_Stackable.Stackable,Stack:_Stack.Stack,TaskStack:_TaskStack.TaskStack,recipes:_recipes.recipes,services:_services.services};var _default=exports.default=collectYourStuff;"undefined"!=typeof window&&(window.collectYourStuff=collectYourStuff);

package/dist/recipes/IsQueue.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @file Queue recipe.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @memberOf module:collect-your-stuff
+ */
+/**
+ * Define a first-in-first-out queue: items are added to the back (enqueue) and taken from the front (dequeue).
+ * This is the shape which si-funciona's queueManager / queueTimeout expect of a queue.
+ */
+export interface IsQueue<T = any> {
+    /**
+     * Take the item from the front of the queue.
+     * @return {T|null} 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 {T} data The item to add
+     */
+    enqueue: (data: T) => void;
+    /**
+     * Look at the item at the front of the queue, without removing it.
+     * @return {T|null} The item, or null when the queue is empty
+     */
+    peek: () => T | null;
+    /**
+     * Count the items in the queue.
+     * @return {number}
+     */
+    size: () => number;
+}

package/dist/recipes/IsQueue.js

@@ -0,0 +1,5 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/recipes/IsQueue.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/recipes/IsStack.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @file Stack recipe.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @memberOf module:collect-your-stuff
+ */
+/**
+ * Define a last-in-first-out stack: items are added to the top (push) and taken from the top (pop).
+ */
+export interface IsStack<T = any> {
+    /**
+     * Check whether the stack has no items.
+     * @return {boolean}
+     */
+    empty: () => boolean;
+    /**
+     * Look at the item on the top of the stack, without removing it.
+     * @return {T|null} The item, or null when the stack is empty
+     */
+    peek: () => T | null;
+    /**
+     * Take the item from the top of the stack.
+     * @return {T|null} The item, or null when the stack is empty
+     */
+    pop: () => T | null;
+    /**
+     * Add an item to the top of the stack.
+     * @param {T} data The item to add
+     */
+    push: (data: T) => void;
+    /**
+     * Count the items in the stack.
+     * @return {number}
+     */
+    size: () => number;
+}