collect-your-stuff 2.1.0 → 2.1.2

package/dist/recipes/LinkerIterator.js

@@ -1,33 +1,33 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-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,
-      done: !this.current
-    }
-    this.current = this.current ? this.current.next : null
-    return result
-  }
-}
-exports.LinkerIterator = LinkerIterator
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+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,
+      done: !this.current
+    }
+    this.current = this.current ? this.current.next : null
+    return result
+  }
+}
+exports.LinkerIterator = LinkerIterator

package/dist/recipes/Runnable.d.ts

@@ -1,55 +1,55 @@
-/**
- * @file Runnable class recipe.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
- */
-/**
- * Return results of the task.
- * @typedef {Object} completeResponse
- * @property {*} success
- * @property {*} error
- * @property {*} context
- */
-export type completeResponse = {
-    success: boolean | any;
-    error: boolean | any;
-    context: any;
-};
-/**
- * Specify a type of class that is Runnable.
- */
-export interface IsRunnable {
-    data: any;
-    get task(): Function;
-    run(): completeResponse | any;
-}
-/**
- * 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=null] The task (a function) or the data which the task returns.
-     */
-    constructor(data?: any);
-    /**
-     * Retrieve the data which should be formed as a task.
-     * @return {Function}
-     */
-    get task(): Function;
-    /**
-     * Run the runnable task.
-     * @return {*}
-     */
-    run(): completeResponse | any;
-    /**
-     * Check if a given thing is Runnable
-     * @memberof Runnable
-     * @param {*} thing The value to check, or nothing to check whether this class is Runnable.
-     * @return {boolean}
-     */
-    static isRunnable(thing: any): boolean;
-}
+/**
+ * @file Runnable class recipe.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @memberOf module:collect-your-stuff
+ */
+/**
+ * Return results of the task.
+ * @typedef {Object} completeResponse
+ * @property {*} success
+ * @property {*} error
+ * @property {*} context
+ */
+export type completeResponse = {
+    success: boolean | any;
+    error: boolean | any;
+    context: any;
+};
+/**
+ * Specify a type of class that is Runnable.
+ */
+export interface IsRunnable {
+    data: any;
+    get task(): Function;
+    run(): completeResponse | any;
+}
+/**
+ * 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=null] The task (a function) or the data which the task returns.
+     */
+    constructor(data?: any);
+    /**
+     * Retrieve the data which should be formed as a task.
+     * @return {Function}
+     */
+    get task(): Function;
+    /**
+     * Run the runnable task.
+     * @return {*}
+     */
+    run(): completeResponse | any;
+    /**
+     * Check if a given thing is Runnable
+     * @memberof Runnable
+     * @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

@@ -1,69 +1,69 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.Runnable = void 0
-/**
- * @file Runnable class recipe.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
- */
-/**
- * Identify a class that can be run.
- */
-class Runnable {
-  /**
-   * Instantiate a Runnable class.
-   * @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
-  }
-
-  /**
-   * Retrieve the data which should be formed as a task.
-   * @return {Function}
-   */
-  get task () {
-    if (typeof this.data === 'function') {
-      return this.data
-    }
-    return () => this.data
-  }
-
-  /**
-   * Run the runnable task.
-   * @return {*}
-   */
-  run () {
-    return this.task()
-  }
-
-  /**
-   * Check if a given thing is Runnable
-   * @memberof Runnable
-   * @param {*} thing The value to check, or nothing to check whether this class is Runnable.
-   * @return {boolean}
-   */
-  static isRunnable (thing) {
-    if (typeof thing === 'undefined') {
-      // No argument past, this class is runnable
-      return this instanceof Runnable
-    }
-    if (typeof thing !== 'object') {
-      // It is not even an object, so cannot be a class instance
-      return false
-    }
-    if (typeof thing.task !== 'function') {
-      // It does not have a task getter that returns a function
-      return false
-    }
-    // Finally, it has a runnable 'run' method. This method should return the result of running the task.
-    return typeof thing.run === 'function'
-  }
-}
-exports.Runnable = Runnable
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.Runnable = void 0
+/**
+ * @file Runnable class recipe.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @memberOf module:collect-your-stuff
+ */
+/**
+ * Identify a class that can be run.
+ */
+class Runnable {
+  /**
+   * Instantiate a Runnable class.
+   * @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
+  }
+
+  /**
+   * Retrieve the data which should be formed as a task.
+   * @return {Function}
+   */
+  get task () {
+    if (typeof this.data === 'function') {
+      return this.data
+    }
+    return () => this.data
+  }
+
+  /**
+   * Run the runnable task.
+   * @return {*}
+   */
+  run () {
+    return this.task()
+  }
+
+  /**
+   * Check if a given thing is Runnable
+   * @memberof Runnable
+   * @param {*} thing The value to check, or nothing to check whether this class is Runnable.
+   * @return {boolean}
+   */
+  static isRunnable (thing) {
+    if (typeof thing === 'undefined') {
+      // No argument past, this class is runnable
+      return this instanceof Runnable
+    }
+    if (typeof thing !== 'object') {
+      // It is not even an object, so cannot be a class instance
+      return false
+    }
+    if (typeof thing.task !== 'function') {
+      // It does not have a task getter that returns a function
+      return false
+    }
+    // Finally, it has a runnable 'run' method. This method should return the result of running the task.
+    return typeof thing.run === 'function'
+  }
+}
+exports.Runnable = Runnable

package/dist/recipes/TreeLinkerIterator.d.ts

@@ -1,20 +1,20 @@
-import { IsTreeNode } from './IsTreeNode';
-/**
- * Class TreeLinkerIterator returns the next value taking a left-first approach down a tree.
- */
-export declare class TreeLinkerIterator implements Iterator<IsTreeNode> {
-    private current;
-    private readonly boundaryParent;
-    /**
-     * Create an iterator starting at the given item.
-     * @param {IsTreeNode} current The item to start from.
-     * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within (null for the top of a tree), the whole tree when not given.
-     */
-    constructor(current: IsTreeNode, boundaryParent?: IsTreeNode | null);
-    /**
-     * 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>;
-}
+import { IsTreeNode } from './IsTreeNode';
+/**
+ * Class TreeLinkerIterator returns the next value taking a left-first approach down a tree.
+ */
+export declare class TreeLinkerIterator implements Iterator<IsTreeNode> {
+    private current;
+    private readonly boundaryParent;
+    /**
+     * Create an iterator starting at the given item.
+     * @param {IsTreeNode} current The item to start from.
+     * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within (null for the top of a tree), the whole tree when not given.
+     */
+    constructor(current: IsTreeNode, boundaryParent?: IsTreeNode | null);
+    /**
+     * 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

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.TreeLinkerIterator = void 0
-var _parseTreeNext = require('../services/parseTreeNext')
+const _parseTreeNext = require('../services/parseTreeNext')
 /**
  * Class TreeLinkerIterator returns the next value taking a left-first approach down a tree.
  */

package/dist/recipes/recipes.d.ts

@@ -1,15 +1,15 @@
-/**
- * @file sample classes which follow a pattern (have certain members or methods).
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
- */
-import { ArrayIterator } from './ArrayIterator';
-import { Runnable } from './Runnable';
-/**
- * List of class declarations that can be used to specify attributes for a style of object / class.
- */
-export declare const recipes: {
-    ArrayIterator: typeof ArrayIterator;
-    Runnable: typeof Runnable;
-};
+/**
+ * @file sample classes which follow a pattern (have certain members or methods).
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @memberOf module:collect-your-stuff
+ */
+import { ArrayIterator } from './ArrayIterator';
+import { Runnable } from './Runnable';
+/**
+ * List of class declarations that can be used to specify attributes for a style of object / class.
+ */
+export declare const recipes: {
+    ArrayIterator: typeof ArrayIterator;
+    Runnable: typeof Runnable;
+};

package/dist/recipes/recipes.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.recipes = void 0
-var _ArrayIterator = require('./ArrayIterator')
-var _Runnable = require('./Runnable')
+const _ArrayIterator = require('./ArrayIterator')
+const _Runnable = require('./Runnable')
 /**
  * @file sample classes which follow a pattern (have certain members or methods).
  * @author Joshua Heagle <joshuaheagle@gmail.com>

package/dist/services/parseTree.d.ts

@@ -1,9 +1,9 @@
-import { forEachCallback } from '../recipes/IsArrayable';
-import { IsTree } from '../recipes/IsTree';
-/**
- * Loop over all the nodes in a tree starting from left and apply a callback for each
- * @param {IsArrayable<IsTreeNode>} tree
- * @param {forEachCallback} callback
- * @returns {IsArrayable<IsTreeNode>}
- */
-export declare const parseTree: (tree: IsTree, callback: forEachCallback) => IsTree;
+import { forEachCallback } from '../recipes/IsArrayable';
+import { IsTree } from '../recipes/IsTree';
+/**
+ * Loop over all the nodes in a tree starting from left and apply a callback for each
+ * @param {IsArrayable<IsTreeNode>} tree
+ * @param {forEachCallback} callback
+ * @returns {IsArrayable<IsTreeNode>}
+ */
+export declare const parseTree: (tree: IsTree, callback: forEachCallback) => IsTree;

package/dist/services/parseTree.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.parseTree = void 0
-var _parseTreeNext = require('./parseTreeNext')
+const _parseTreeNext = require('./parseTreeNext')
 /**
  * Loop over all the nodes in a tree starting from left and apply a callback for each
  * @param {IsArrayable<IsTreeNode>} tree

package/dist/services/parseTreeNext.d.ts

@@ -1,17 +1,17 @@
-import { IsTreeNode } from '../recipes/IsTreeNode';
-/**
- * Be able to parse over every node in a tree.
- * 1. Start at root (get root parent)
- * 2. Get first child (repeat until no children)
- * 3. Check next child
- * 4. Repeat 2
- * 5. Repeat 3
- * 6. If no next child, return to parent and repeat 3
- * 7. Stop at root (next is null and parent is null
- * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
- * parsing stays within the nodes whose parent is the boundary (and everything below them).
- * @param {IsTreeNode} treeNode Provide a node in a tree and get the next node (left-first approach)
- * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
- * @returns {IsTreeNode|null}
- */
-export declare const parseTreeNext: (treeNode: IsTreeNode, boundaryParent?: IsTreeNode | null) => IsTreeNode | null;
+import { IsTreeNode } from '../recipes/IsTreeNode';
+/**
+ * Be able to parse over every node in a tree.
+ * 1. Start at root (get root parent)
+ * 2. Get first child (repeat until no children)
+ * 3. Check next child
+ * 4. Repeat 2
+ * 5. Repeat 3
+ * 6. If no next child, return to parent and repeat 3
+ * 7. Stop at root (next is null and parent is null
+ * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
+ * parsing stays within the nodes whose parent is the boundary (and everything below them).
+ * @param {IsTreeNode} treeNode Provide a node in a tree and get the next node (left-first approach)
+ * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
+ * @returns {IsTreeNode|null}
+ */
+export declare const parseTreeNext: (treeNode: IsTreeNode, boundaryParent?: IsTreeNode | null) => IsTreeNode | null;

package/dist/services/parseTreeNext.js

@@ -1,42 +1,42 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.parseTreeNext = void 0
-/**
- * Be able to parse over every node in a tree.
- * 1. Start at root (get root parent)
- * 2. Get first child (repeat until no children)
- * 3. Check next child
- * 4. Repeat 2
- * 5. Repeat 3
- * 6. If no next child, return to parent and repeat 3
- * 7. Stop at root (next is null and parent is null
- * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
- * parsing stays within the nodes whose parent is the boundary (and everything below them).
- * @param {IsTreeNode} treeNode Provide a node in a tree and get the next node (left-first approach)
- * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
- * @returns {IsTreeNode|null}
- */
-const parseTreeNext = (treeNode, boundaryParent) => {
-  if (!treeNode) {
-    return null
-  }
-  if (treeNode.children && treeNode.children.length) {
-    return treeNode.children.first
-  }
-  if (treeNode.next) {
-    return treeNode.next
-  }
-  // Nothing more below or beside this node, so go back up until there is a node which has a next (or the boundary)
-  let parent = treeNode.parent
-  while (parent && parent !== boundaryParent) {
-    if (parent.next) {
-      return parent.next
-    }
-    parent = parent.parent
-  }
-  return null
-}
-exports.parseTreeNext = parseTreeNext
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.parseTreeNext = void 0
+/**
+ * Be able to parse over every node in a tree.
+ * 1. Start at root (get root parent)
+ * 2. Get first child (repeat until no children)
+ * 3. Check next child
+ * 4. Repeat 2
+ * 5. Repeat 3
+ * 6. If no next child, return to parent and repeat 3
+ * 7. Stop at root (next is null and parent is null
+ * A boundary can be given to parse only part of a tree: going back up to the parents stops at the boundary, so the
+ * parsing stays within the nodes whose parent is the boundary (and everything below them).
+ * @param {IsTreeNode} treeNode Provide a node in a tree and get the next node (left-first approach)
+ * @param {IsTreeNode|null} [boundaryParent] The parent of the nodes to stay within, null for the nodes at the top of a tree. When it is not given the whole tree is parsed.
+ * @returns {IsTreeNode|null}
+ */
+const parseTreeNext = (treeNode, boundaryParent) => {
+  if (!treeNode) {
+    return null
+  }
+  if (treeNode.children && treeNode.children.length) {
+    return treeNode.children.first
+  }
+  if (treeNode.next) {
+    return treeNode.next
+  }
+  // Nothing more below or beside this node, so go back up until there is a node which has a next (or the boundary)
+  let parent = treeNode.parent
+  while (parent && parent !== boundaryParent) {
+    if (parent.next) {
+      return parent.next
+    }
+    parent = parent.parent
+  }
+  return null
+}
+exports.parseTreeNext = parseTreeNext

package/dist/services/services.d.ts

@@ -1,13 +1,13 @@
-/**
- * @file some useful resources when working with collections.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-/**
- * List helpful functions when dealing with collections.
- */
-export declare const services: {
-    parseTree: (tree: import("../main").IsTree, callback: import("../main").forEachCallback) => import("../main").IsTree;
-    parseTreeNext: (treeNode: import("../main").IsTreeNode, boundaryParent?: import("../main").IsTreeNode | null) => import("../main").IsTreeNode | null;
-};
+/**
+ * @file some useful resources when working with collections.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+/**
+ * List helpful functions when dealing with collections.
+ */
+export declare const services: {
+    parseTree: (tree: import("../main").IsTree, callback: import("../main").forEachCallback) => import("../main").IsTree;
+    parseTreeNext: (treeNode: import("../main").IsTreeNode, boundaryParent?: import("../main").IsTreeNode | null) => import("../main").IsTreeNode | null;
+};

package/dist/services/services.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.services = void 0
-var _parseTree = require('./parseTree')
-var _parseTreeNext = require('./parseTreeNext')
+const _parseTree = require('./parseTree')
+const _parseTreeNext = require('./parseTreeNext')
 /**
  * @file some useful resources when working with collections.
  * @author Joshua Heagle <joshuaheagle@gmail.com>

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": "2.1.0",
+  "version": "2.1.2",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
   "author": "Joshua Heagle",
@@ -25,7 +25,7 @@
     "watch:test": "gulp watchTest"
   },
   "devDependencies": {
-    "js-build-tools": "^4.1.1"
+    "js-build-tools": "^5.2.0"
   },
   "repository": {
     "type": "git",