collect-your-stuff 1.3.0 → 1.3.2

package/dist/collections/stack/Stackable.js

@@ -12,7 +12,7 @@ var _Linker = require('../linked-list/Linker')
 class Stackable {
   /**
    * Create a stackable item that can be used in a stack.
-   * @param {Object} [stackData={}]
+   * @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
@@ -22,7 +22,9 @@ class Stackable {
     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
@@ -56,8 +58,8 @@ class Stackable {
  */
 exports.Stackable = Stackable
 Stackable.make = (stackable, classType = Stackable) => {
-  if (typeof stackable !== 'object') {
-    // It is not an object, so instantiate the Stackable with stackable as the data
+  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
     })
@@ -66,13 +68,13 @@ Stackable.make = (stackable, classType = Stackable) => {
     // Already valid Stackable, return as-is
     return stackable
   }
-  if (!stackable.task) {
+  if (!('task' in stackable)) {
     stackable = {
       task: stackable
     }
   }
   // Create the new node as the configured stackableClass
-  return new Stackable(stackable)
+  return new classType(stackable)
 }
 /**
  * Convert an array into Stackable instances, return the head and tail Stackables.

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Stackable=void 0;var _Linker=require("../linked-list/Linker");class Stackable{constructor({task:t=null,next:a=null,ready:e=!1}={}){this.data=null,this.next=null,this.classType=Stackable,this.data=t,this.next=a}get task(){return"function"==typeof this.data?this.data:()=>this.data}run(){return this.task()}}exports.Stackable=Stackable,Stackable.make=(t,a=Stackable)=>"object"!=typeof t?new a({task:t}):t.classType?t:(t.task||(t={task:t}),new Stackable(t)),Stackable.fromArray=(t=[],a=Stackable)=>_Linker.Linker.fromArray(t,a);
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Stackable=void 0;var _Linker=require("../linked-list/Linker");class Stackable{constructor({task:t=null,next:a=null,ready:e=!1}={}){this.data=null,this.next=null,this.classType=Stackable,this.data=t,this.next=a}get task(){return"function"==typeof this.data?this.data:()=>this.data}run(){return this.task()}}exports.Stackable=Stackable,Stackable.make=(t,a=Stackable)=>null===t||"object"!=typeof t?new a({task:t}):t.classType?t:("task"in t||(t={task:t}),new a(t)),Stackable.fromArray=(t=[],a=Stackable)=>_Linker.Linker.fromArray(t,a);

package/dist/main.d.ts

@@ -56,8 +56,8 @@ declare const collectYourStuff: {
         Runnable: typeof import("./recipes/Runnable").Runnable;
     };
     services: {
-        parseTree: (tree: import("./recipes/IsTree").IsTree, callback: import("./recipes/IsArrayable").forEachCallback) => import("./recipes/IsTree").IsTree;
-        parseTreeNext: (treeNode: import("./recipes/IsTreeNode").IsTreeNode) => import("./recipes/IsTreeNode").IsTreeNode | null;
+        parseTree: (tree: import("./main").IsTree, callback: import("./main").forEachCallback) => import("./main").IsTree;
+        parseTreeNext: (treeNode: import("./main").IsTreeNode) => import("./main").IsTreeNode | null;
     };
 };
 export default collectYourStuff;

package/dist/recipes/ArrayIterator.d.ts

@@ -5,6 +5,16 @@ import { IsElement } from './IsElement';
 export declare class ArrayIterator implements Iterator<IsElement> {
     private readonly innerList;
     private index;
+    /**
+     * Create an iterator over the given array.
+     * @param {Array<IsElement>} innerList The elements to iterate over.
+     * @param {number} [index=0] The position to start from.
+     */
     constructor(innerList: Array<IsElement>, index?: number);
+    /**
+     * Get the next element, moving the iterator forward.
+     * @param {*} [value] Not used, present to match the Iterator interface.
+     * @return {IteratorResult<IsElement>} The next element, or done when there are no more.
+     */
     next(value?: any): IteratorResult<IsElement>;
 }

package/dist/recipes/ArrayIterator.js

@@ -8,11 +8,21 @@ exports.ArrayIterator = void 0
  * Class ArrayIterator returns the next value when using elements of array type list.
  */
 class ArrayIterator {
+  /**
+   * Create an iterator over the given array.
+   * @param {Array<IsElement>} innerList The elements to iterate over.
+   * @param {number} [index=0] The position to start from.
+   */
   constructor (innerList, index = 0) {
     this.innerList = innerList
     this.index = index
   }
 
+  /**
+   * Get the next element, moving the iterator forward.
+   * @param {*} [value] Not used, present to match the Iterator interface.
+   * @return {IteratorResult<IsElement>} The next element, or done when there are no more.
+   */
   next (value) {
     if (this.index < this.innerList.length) {
       return {

package/dist/recipes/DoubleLinkerIterator.d.ts

@@ -4,6 +4,15 @@ import { IsDoubleLinker } from './IsDoubleLinker';
  */
 export declare class DoubleLinkerIterator implements Iterator<IsDoubleLinker> {
     private current;
+    /**
+     * Create an iterator starting at the given item.
+     * @param {IsDoubleLinker} current The item to start from.
+     */
     constructor(current: IsDoubleLinker);
+    /**
+     * Get the current item and move on to the following one.
+     * @param {*} [value] Not used, present to match the Iterator interface.
+     * @return {IteratorResult<IsDoubleLinker>} The current item, or done when there are no more.
+     */
     next(value?: any): IteratorResult<IsDoubleLinker>;
 }

package/dist/recipes/DoubleLinkerIterator.js

@@ -8,10 +8,19 @@ exports.DoubleLinkerIterator = void 0
  * Class DoubleLinkerIterator returns the next value when using linkers of linked type lists.
  */
 class DoubleLinkerIterator {
+  /**
+   * Create an iterator starting at the given item.
+   * @param {IsDoubleLinker} current The item to start from.
+   */
   constructor (current) {
     this.current = current
   }
 
+  /**
+   * Get the current item and move on to the following one.
+   * @param {*} [value] Not used, present to match the Iterator interface.
+   * @return {IteratorResult<IsDoubleLinker>} The current item, or done when there are no more.
+   */
   next (value) {
     const result = {
       value: this.current,

package/dist/recipes/LinkerIterator.d.ts

@@ -4,6 +4,15 @@ import { IsLinker } from './IsLinker';
  */
 export declare class LinkerIterator implements Iterator<IsLinker> {
     private current;
+    /**
+     * Create an iterator starting at the given item.
+     * @param {IsLinker} current The item to start from.
+     */
     constructor(current: IsLinker);
+    /**
+     * Get the current item and move on to the following one.
+     * @param {*} [value] Not used, present to match the Iterator interface.
+     * @return {IteratorResult<IsLinker>} The current item, or done when there are no more.
+     */
     next(value?: any): IteratorResult<IsLinker>;
 }

package/dist/recipes/LinkerIterator.js

@@ -8,10 +8,19 @@ exports.LinkerIterator = void 0
  * Class LinkerIterator returns the next value when using linkers of linked type lists.
  */
 class LinkerIterator {
+  /**
+   * Create an iterator starting at the given item.
+   * @param {IsLinker} current The item to start from.
+   */
   constructor (current) {
     this.current = current
   }
 
+  /**
+   * Get the current item and move on to the following one.
+   * @param {*} [value] Not used, present to match the Iterator interface.
+   * @return {IteratorResult<IsLinker>} The current item, or done when there are no more.
+   */
   next (value) {
     const result = {
       value: this.current,

package/dist/recipes/Runnable.d.ts

@@ -28,10 +28,11 @@ export interface IsRunnable {
  * Identify a class that can be run.
  */
 export declare class Runnable implements IsRunnable {
+    /** The task (or data) this runnable holds. */
     data: any;
     /**
      * Instantiate a Runnable class.
-     * @param {*} data
+     * @param {*} [data=null] The task (a function) or the data which the task returns.
      */
     constructor(data?: any);
     /**
@@ -47,7 +48,7 @@ export declare class Runnable implements IsRunnable {
     /**
      * Check if a given thing is Runnable
      * @memberof Runnable
-     * @param {*} thing
+     * @param {*} thing The value to check, or nothing to check whether this class is Runnable.
      * @return {boolean}
      */
     static isRunnable(thing: any): boolean;

package/dist/recipes/Runnable.js

@@ -16,9 +16,10 @@ exports.Runnable = void 0
 class Runnable {
   /**
    * Instantiate a Runnable class.
-   * @param {*} data
+   * @param {*} [data=null] The task (a function) or the data which the task returns.
    */
   constructor (data = null) {
+    /** The task (or data) this runnable holds. */
     this.data = null
     this.data = data
   }
@@ -45,7 +46,7 @@ class Runnable {
   /**
    * Check if a given thing is Runnable
    * @memberof Runnable
-   * @param {*} thing
+   * @param {*} thing The value to check, or nothing to check whether this class is Runnable.
    * @return {boolean}
    */
   static isRunnable (thing) {

package/dist/recipes/TreeLinkerIterator.d.ts

@@ -4,6 +4,15 @@ import { IsTreeNode } from './IsTreeNode';
  */
 export declare class TreeLinkerIterator implements Iterator<IsTreeNode> {
     private current;
+    /**
+     * Create an iterator starting at the given item.
+     * @param {IsTreeNode} current The item to start from.
+     */
     constructor(current: IsTreeNode);
+    /**
+     * Get the current item and move on to the following one (left-first, down each branch).
+     * @param {*} [value] Not used, present to match the Iterator interface.
+     * @return {IteratorResult<IsTreeNode>} The current item, or done when there are no more.
+     */
     next(value?: any): IteratorResult<IsTreeNode>;
 }

package/dist/recipes/TreeLinkerIterator.js

@@ -9,10 +9,19 @@ var _parseTreeNext = require('../services/parseTreeNext')
  * Class TreeLinkerIterator returns the next value taking a left-first approach down a tree.
  */
 class TreeLinkerIterator {
+  /**
+   * Create an iterator starting at the given item.
+   * @param {IsTreeNode} current The item to start from.
+   */
   constructor (current) {
     this.current = current
   }
 
+  /**
+   * Get the current item and move on to the following one (left-first, down each branch).
+   * @param {*} [value] Not used, present to match the Iterator interface.
+   * @return {IteratorResult<IsTreeNode>} The current item, or done when there are no more.
+   */
   next (value) {
     const result = {
       value: this.current,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "collect-your-stuff",
   "description": "Use a variety of collections to collect your stuff when building code.",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
   "author": "Joshua Heagle",
@@ -19,6 +19,7 @@
     "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
     "readme": "gulp readme",
     "test": "gulp testFull",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
     "test:quick": "gulp testQuick",
     "watch": "gulp watchFull",
     "watch:test": "gulp watchTest"