collect-your-stuff 2.1.1 → 2.2.0

package/dist/collections/stack/Stack.js

@@ -1,127 +1,122 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-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')
-var _Linker = require('../linked-list/Linker')
-/**
- * @file stack.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 2.0.0
- * @memberOf module:collect-your-stuff
- */
-
-/**
- * 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 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, linkerClass = _Linker.Linker) {
-    this.linkerClass = linkerClass
-    this.stackedList = stackedList === null ? new listClass(linkerClass) : stackedList
-  }
-
-  /**
-   * Check whether the stack has no items.
-   * @return {boolean}
-   */
-  empty () {
-    return this.size() <= 0
-  }
-
-  /**
-   * Look at the item on the top of the stack, without removing it.
-   * @return {*|null} The item, or null when the stack is empty
-   */
-  peek () {
-    const top = this.stackedList.first
-    return top === null || typeof top === 'undefined' ? null : top.data
-  }
-
-  /**
-   * Take the item from the top of the stack.
-   * @return {*|null} The item, or null when the stack is empty
-   */
-  pop () {
-    const top = this.stackedList.first
-    if (top === null || typeof top === 'undefined') {
-      return null
-    }
-    this.stackedList.remove(top)
-    return top.data
-  }
-
-  /**
-   * 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 (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
-  }
-
-  /**
-   * Count the items in the stack.
-   * @return {number}
-   */
-  size () {
-    return this.stackedList.length
-  }
-
-  /**
-   * The item on the top of the stack (the same as peek).
-   * @return {*|null} The item, or null when the stack is empty
-   */
-  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 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 = [], listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) => {
-  const stack = new Stack(null, listClass, linkerClass)
-  values.forEach(value => stack.push(value))
-  return stack
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.Stack = 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')
+/**
+ * stack.
+ */
+
+/**
+ * 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 stack, optionally with a list of items to start from.
+   * @param stackedList The list of linkers to start in this stack (the first is the top)
+   * @param listClass The type of list to create when no stacked list is given
+   * @param linkerClass The class used to hold each stacked item
+   */
+  constructor (stackedList = null, listClass = _LinkedList.LinkedList, linkerClass = _Linker.Linker) {
+    this.linkerClass = linkerClass
+    this.stackedList = stackedList === null ? new listClass(linkerClass) : stackedList
+  }
+
+  /**
+   * Check whether the stack has no items.
+   */
+  empty () {
+    return this.size() <= 0
+  }
+
+  /**
+   * Look at the item on the top of the stack, without removing it.
+   * @returns The item, or null when the stack is empty
+   */
+  peek () {
+    const top = this.stackedList.first
+    return top === null || typeof top === 'undefined' ? null : top.data
+  }
+
+  /**
+   * Take the item from the top of the stack.
+   * @returns The item, or null when the stack is empty
+   */
+  pop () {
+    const top = this.stackedList.first
+    if (top === null || typeof top === 'undefined') {
+      return null
+    }
+    this.stackedList.remove(top)
+    return top.data
+  }
+
+  /**
+   * Add an item to the top of the stack.
+   * @param data The item to add
+   * @returns This stack, so that adding can be chained
+   */
+  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
+  }
+
+  /**
+   * Count the items in the stack.
+   */
+  size () {
+    return this.stackedList.length
+  }
+
+  /**
+   * The item on the top of the stack (the same as peek).
+   * @returns The item, or null when the stack is empty
+   */
+  top () {
+    return this.peek()
+  }
+
+  /**
+   * Iterate over the items from the top of the stack to the bottom, without removing them.
+   */
+  [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 by pushing each value in turn, so the last value is on the top.
+ * @param values The items to stack
+ * @param listClass The type of list used to store the items
+ * @param linkerClass The class used to hold each stacked item
+ */
+exports.Stack = Stack
+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/Stackable.d.ts

@@ -1,59 +1,52 @@
-/**
- * @file stack.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { IsRunnable } from '../../recipes/Runnable';
-import { IsLinker } from '../../recipes/IsLinker';
-/**
- * Stackable represents a runnable entry in stack.
- * @extends Linker
- */
-export declare class Stackable implements IsLinker, IsRunnable {
-    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
-    readonly classType: typeof Stackable;
-    /** The task (or data) this stackable holds. */
-    data: any;
-    /** The stackable below this one, or null when this is the bottom. */
-    next: Stackable | null;
-    /**
-     * Create a stackable item that can be used in a stack.
-     * @param {Object} [stackData={}] The settings for the new stackable.
-     * @param {*} [stackData.task=null] The data to be stored in this stackable
-     * @param {Stackable|null} [stackData.next=null] The reference to the next stackable if any
-     * @param {boolean|Function} [stackData.ready=false] Indicate if the stackable is ready to run
-     */
-    constructor({ task, next, ready }?: {
-        task?: any;
-        next?: Stackable | null;
-        ready?: boolean;
-    });
-    /**
-     * Retrieve the data which should be formed as a task.
-     * @return {*}
-     */
-    get task(): any;
-    /**
-     * Run the stacked task.
-     * @return {*}
-     */
-    run(): any;
-    /**
-     * Make a new Stackable from the data given if it is not already a valid Stackable.
-     * @param {Stackable|*} stackable Return a valid Stackable instance from given data, or even an already valid one.
-     * @param {IsLinker} [classType=Stackable] Provide the type of IsLinker to use.
-     * @return {Stackable}
-     */
-    static make: (stackable: Stackable | any, classType?: any) => Stackable;
-    /**
-     * Convert an array into Stackable instances, return the head and tail Stackables.
-     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of stackable linkers.
-     * @param {IsLinker} [classType=Stackable] Provide the type of IsLinker to use.
-     * @returns {{head: Stackable, tail: Stackable}}
-     */
-    static fromArray: (values?: Array<any>, classType?: any) => {
-        head: IsLinker;
-        tail: IsLinker;
-    };
-}
+/**
+ * stack.
+ */
+import { IsRunnable } from '../../recipes/Runnable';
+import { IsLinker } from '../../recipes/IsLinker';
+/**
+ * Stackable represents a runnable entry in stack.
+ * @extends Linker
+ */
+export declare class Stackable implements IsLinker, IsRunnable {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
+    readonly classType: typeof Stackable;
+    /** The task (or data) this stackable holds. */
+    data: any;
+    /** The stackable below this one, or null when this is the bottom. */
+    next: Stackable | null;
+    /**
+     * Create a stackable item that can be used in a stack.
+     * @param stackData The settings for the new stackable.
+     * @param stackData.task The data to be stored in this stackable
+     * @param stackData.next The reference to the next stackable if any
+     * @param stackData.ready Indicate if the stackable is ready to run
+     */
+    constructor({ task, next, ready }?: {
+        task?: any;
+        next?: Stackable | null;
+        ready?: boolean;
+    });
+    /**
+     * Retrieve the data which should be formed as a task.
+     */
+    get task(): any;
+    /**
+     * Run the stacked task.
+     */
+    run(): any;
+    /**
+     * Make a new Stackable from the data given if it is not already a valid Stackable.
+     * @param stackable Return a valid Stackable instance from given data, or even an already valid one.
+     * @param classType Provide the type of IsLinker to use.
+     */
+    static make: (stackable: Stackable | any, classType?: any) => Stackable;
+    /**
+     * Convert an array into Stackable instances, return the head and tail Stackables.
+     * @param values Provide an array of data that will be converted to a chain of stackable linkers.
+     * @param classType Provide the type of IsLinker to use.
+     */
+    static fromArray: (values?: Array<any>, classType?: any) => {
+        head: IsLinker;
+        tail: IsLinker;
+    };
+}

package/dist/collections/stack/Stackable.js

@@ -1,85 +1,81 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.Stackable = void 0
-var _Linker = require('../linked-list/Linker')
-/**
- * Stackable represents a runnable entry in stack.
- * @extends Linker
- */
-class Stackable {
-  /**
-   * Create a stackable item that can be used in a stack.
-   * @param {Object} [stackData={}] The settings for the new stackable.
-   * @param {*} [stackData.task=null] The data to be stored in this stackable
-   * @param {Stackable|null} [stackData.next=null] The reference to the next stackable if any
-   * @param {boolean|Function} [stackData.ready=false] Indicate if the stackable is ready to run
-   */
-  constructor ({
-    task = null,
-    next = null,
-    ready = false
-  } = {}) {
-    /** The task (or data) this stackable holds. */
-    this.data = null
-    /** The stackable below this one, or null when this is the bottom. */
-    this.next = null
-    this.classType = Stackable
-    this.data = task
-    this.next = next
-  }
-
-  /**
-   * Retrieve the data which should be formed as a task.
-   * @return {*}
-   */
-  get task () {
-    if (typeof this.data === 'function') {
-      return this.data
-    }
-    return () => this.data
-  }
-
-  /**
-   * Run the stacked task.
-   * @return {*}
-   */
-  run () {
-    return this.task()
-  }
-}
-/**
- * Make a new Stackable from the data given if it is not already a valid Stackable.
- * @param {Stackable|*} stackable Return a valid Stackable instance from given data, or even an already valid one.
- * @param {IsLinker} [classType=Stackable] Provide the type of IsLinker to use.
- * @return {Stackable}
- */
-exports.Stackable = Stackable
-Stackable.make = (stackable, classType = Stackable) => {
-  if (stackable === null || typeof stackable !== 'object') {
-    // It is not an object (or it is null), so instantiate the Stackable with stackable as the data
-    return new classType({
-      task: stackable
-    })
-  }
-  if (stackable.classType) {
-    // Already valid Stackable, return as-is
-    return stackable
-  }
-  if (!('task' in stackable)) {
-    stackable = {
-      task: stackable
-    }
-  }
-  // Create the new node as the configured stackableClass
-  return new classType(stackable)
-}
-/**
- * Convert an array into Stackable instances, return the head and tail Stackables.
- * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of stackable linkers.
- * @param {IsLinker} [classType=Stackable] Provide the type of IsLinker to use.
- * @returns {{head: Stackable, tail: Stackable}}
- */
-Stackable.fromArray = (values = [], classType = Stackable) => _Linker.Linker.fromArray(values, classType)
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.Stackable = void 0
+const _Linker = require('../linked-list/Linker')
+/**
+ * Stackable represents a runnable entry in stack.
+ * @extends Linker
+ */
+class Stackable {
+  /**
+   * Create a stackable item that can be used in a stack.
+   * @param stackData The settings for the new stackable.
+   * @param stackData.task The data to be stored in this stackable
+   * @param stackData.next The reference to the next stackable if any
+   * @param stackData.ready Indicate if the stackable is ready to run
+   */
+  constructor ({
+    task = null,
+    next = null,
+    ready = false
+  } = {}) {
+    /** The task (or data) this stackable holds. */
+    this.data = null
+    /** The stackable below this one, or null when this is the bottom. */
+    this.next = null
+    this.classType = Stackable
+    this.data = task
+    this.next = next
+  }
+
+  /**
+   * Retrieve the data which should be formed as a task.
+   */
+  get task () {
+    if (typeof this.data === 'function') {
+      return this.data
+    }
+    return () => this.data
+  }
+
+  /**
+   * Run the stacked task.
+   */
+  run () {
+    return this.task()
+  }
+}
+/**
+ * Make a new Stackable from the data given if it is not already a valid Stackable.
+ * @param stackable Return a valid Stackable instance from given data, or even an already valid one.
+ * @param classType Provide the type of IsLinker to use.
+ */
+exports.Stackable = Stackable
+Stackable.make = (stackable, classType = Stackable) => {
+  if (stackable === null || typeof stackable !== 'object') {
+    // It is not an object (or it is null), so instantiate the Stackable with stackable as the data
+    return new classType({
+      task: stackable
+    })
+  }
+  if (stackable.classType) {
+    // Already valid Stackable, return as-is
+    return stackable
+  }
+  if (!('task' in stackable)) {
+    stackable = {
+      task: stackable
+    }
+  }
+  // Create the new node as the configured stackableClass
+  return new classType(stackable)
+}
+/**
+ * Convert an array into Stackable instances, return the head and tail Stackables.
+ * @param values Provide an array of data that will be converted to a chain of stackable linkers.
+ * @param classType Provide the type of IsLinker to use.
+ */
+Stackable.fromArray = (values = [], classType = Stackable) => _Linker.Linker.fromArray(values, classType)