collect-your-stuff 2.1.1 → 2.2.0

package/dist/recipes/IsTreeNode.d.ts

@@ -1,29 +1,29 @@
-import { IsArrayable } from './IsArrayable';
-import { IsDoubleLinker } from './IsDoubleLinker';
-import { LinkedTreeList } from '../collections/linked-tree-list/LinkedTreeList';
-/**
- * Define the common attributes of a Tree Node for a tree structure.
- */
-export interface IsTreeNode extends IsDoubleLinker {
-    /**
-     * @property {IsTreeNode} [next=null]
-     */
-    next: IsTreeNode;
-    /**
-     * @property {IsTreeNode} [prev=null]
-     */
-    prev: IsTreeNode;
-    /**
-     * @property {IsTreeNode|null} [parent=null]
-     */
-    parent: IsTreeNode | null;
-    /**
-     * @property {IsArrayable<IsTreeNode>|null} [children=null]
-     */
-    children: IsArrayable<IsTreeNode> | null;
-    /**
-     * Create the children for this tree from an array.
-     * @param {Array} children
-     */
-    childrenFromArray(children: Array<any> | null): LinkedTreeList;
-}
+import { IsArrayable } from './IsArrayable';
+import { IsDoubleLinker } from './IsDoubleLinker';
+import { LinkedTreeList } from '../collections/linked-tree-list/LinkedTreeList';
+/**
+ * Define the common attributes of a Tree Node for a tree structure.
+ */
+export interface IsTreeNode extends IsDoubleLinker {
+    /**
+     * @property {IsTreeNode} [next=null]
+     */
+    next: IsTreeNode;
+    /**
+     * @property {IsTreeNode} [prev=null]
+     */
+    prev: IsTreeNode;
+    /**
+     * @property {IsTreeNode|null} [parent=null]
+     */
+    parent: IsTreeNode | null;
+    /**
+     * @property {IsArrayable<IsTreeNode>|null} [children=null]
+     */
+    children: IsArrayable<IsTreeNode> | null;
+    /**
+     * Create the children for this tree from an array.
+     * @param children
+     */
+    childrenFromArray(children: Array<any> | null): LinkedTreeList;
+}

package/dist/recipes/IsTreeNode.js

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

package/dist/recipes/LinkerIterator.d.ts

@@ -1,18 +1,18 @@
-import { IsLinker } from './IsLinker';
-/**
- * Class LinkerIterator returns the next value when using linkers of linked type lists.
- */
-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>;
-}
+import { IsLinker } from './IsLinker';
+/**
+ * Class LinkerIterator returns the next value when using linkers of linked type lists.
+ */
+export declare class LinkerIterator implements Iterator<IsLinker> {
+    private current;
+    /**
+     * Create an iterator starting at the given item.
+     * @param 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.
+     * @returns The current item, or done when there are no more.
+     */
+    next(value?: any): IteratorResult<IsLinker>;
+}

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 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.
+   * @returns 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,42 @@
-/**
- * @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;
-}
+/**
+ * Runnable class recipe.
+ */
+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 The task (a function) or the data which the task returns.
+     */
+    constructor(data?: any);
+    /**
+     * Retrieve the data which should be formed as a task.
+     */
+    get task(): Function;
+    /**
+     * Run the runnable task.
+     */
+    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.
+     */
+    static isRunnable(thing: any): boolean;
+}

package/dist/recipes/Runnable.js

@@ -1,69 +1,63 @@
-'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
+/**
+ * Runnable class recipe.
+ */
+/**
+ * Identify a class that can be run.
+ */
+class Runnable {
+  /**
+   * Instantiate a Runnable class.
+   * @param data 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.
+   */
+  get task () {
+    if (typeof this.data === 'function') {
+      return this.data
+    }
+    return () => this.data
+  }
+
+  /**
+   * Run the runnable task.
+   */
+  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.
+   */
+  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 current The item to start from.
+     * @param 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.
+     * @returns The current item, or done when there are no more.
+     */
+    next(value?: any): IteratorResult<IsTreeNode>;
+}

package/dist/recipes/TreeLinkerIterator.js

@@ -1,36 +1,36 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.TreeLinkerIterator = void 0
-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.
-   * @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, boundaryParent) {
-    this.current = current
-    this.boundaryParent = boundaryParent
-  }
-
-  /**
-   * 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,
-      done: !this.current
-    }
-    this.current = (0, _parseTreeNext.parseTreeNext)(this.current, this.boundaryParent)
-    return result
-  }
-}
-exports.TreeLinkerIterator = TreeLinkerIterator
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.TreeLinkerIterator = void 0
+const _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 current The item to start from.
+   * @param boundaryParent The parent of the nodes to stay within (null for the top of a tree), the whole tree when not given.
+   */
+  constructor (current, boundaryParent) {
+    this.current = current
+    this.boundaryParent = boundaryParent
+  }
+
+  /**
+   * 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.
+   * @returns The current item, or done when there are no more.
+   */
+  next (value) {
+    const result = {
+      value: this.current,
+      done: !this.current
+    }
+    this.current = (0, _parseTreeNext.parseTreeNext)(this.current, this.boundaryParent)
+    return result
+  }
+}
+exports.TreeLinkerIterator = TreeLinkerIterator

package/dist/recipes/recipes.d.ts

@@ -1,15 +1,12 @@
-/**
- * @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;
-};
+/**
+ * sample classes which follow a pattern (have certain members or methods).
+ */
+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

@@ -1,22 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.recipes = void 0
-var _ArrayIterator = require('./ArrayIterator')
-var _Runnable = require('./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
- */
-
-/**
- * List of class declarations that can be used to specify attributes for a style of object / class.
- */
-const recipes = exports.recipes = {
-  ArrayIterator: _ArrayIterator.ArrayIterator,
-  Runnable: _Runnable.Runnable
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.recipes = void 0
+const _ArrayIterator = require('./ArrayIterator')
+const _Runnable = require('./Runnable')
+/**
+ * sample classes which follow a pattern (have certain members or methods).
+ */
+
+/**
+ * List of class declarations that can be used to specify attributes for a style of object / class.
+ */
+const recipes = exports.recipes = {
+  ArrayIterator: _ArrayIterator.ArrayIterator,
+  Runnable: _Runnable.Runnable
+}

package/dist/services/parseTree.d.ts

@@ -1,9 +1,8 @@
-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 tree
+ * @param callback
+ */
+export declare const parseTree: (tree: IsTree, callback: forEachCallback) => IsTree;