collect-your-stuff 2.1.2 → 2.2.0

package/dist/recipes/ArrayIterator.d.ts

@@ -7,14 +7,14 @@ export declare class ArrayIterator implements Iterator<IsElement> {
     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.
+     * @param innerList The elements to iterate over.
+     * @param index 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.
+     * @param value Not used, present to match the Iterator interface.
+     * @returns The next element, or done when there are no more.
      */
     next(value?: any): IteratorResult<IsElement>;
 }

package/dist/recipes/ArrayIterator.js

@@ -10,8 +10,8 @@ exports.ArrayIterator = void 0
 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.
+   * @param innerList The elements to iterate over.
+   * @param index The position to start from.
    */
   constructor (innerList, index = 0) {
     this.innerList = innerList
@@ -20,8 +20,8 @@ class ArrayIterator {
 
   /**
    * 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.
+   * @param value Not used, present to match the Iterator interface.
+   * @returns The next element, or done when there are no more.
    */
   next (value) {
     if (this.index < this.innerList.length) {

package/dist/recipes/DoubleLinkerIterator.d.ts

@@ -6,13 +6,13 @@ 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.
+     * @param 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.
+     * @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<IsDoubleLinker>;
 }

package/dist/recipes/DoubleLinkerIterator.js

@@ -10,7 +10,7 @@ exports.DoubleLinkerIterator = void 0
 class DoubleLinkerIterator {
   /**
    * Create an iterator starting at the given item.
-   * @param {IsDoubleLinker} current The item to start from.
+   * @param current The item to start from.
    */
   constructor (current) {
     this.current = current
@@ -18,8 +18,8 @@ class DoubleLinkerIterator {
 
   /**
    * 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.
+   * @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 = {

package/dist/recipes/IsArrayable.d.ts

@@ -1,11 +1,4 @@
 import { IsElement } from './IsElement';
-/**
- * Run this function for each element in this arrayable.
- * @callback forEachCallback
- * @param {number} index
- * @param {IsArrayable} thisArg
- * @returns void
- */
 export type forEachCallback = (element: IsElement, index?: number, thisArg?: IsArrayable<any>) => void;
 /**
  * Arrayable represents a collection stored as Elements.
@@ -26,80 +19,67 @@ export interface IsArrayable<T extends IsElement> {
     initialized: boolean;
     /**
      * Initialize the inner list, should only run once.
-     * @param {IsArrayable|Array} initialList
-     * @return {IsArrayable}
+     * @param initialList
      */
     initialize(initialList: Array<T> | T): IsArrayable<any>;
     /**
      * Retrieve a copy of the innerList used.
-     * @returns {Array}
      */
     get list(): Array<IsElement> | IsElement;
     /**
      * Retrieve the first Element from the Arrayable
-     * @returns {IsElement}
      */
     get first(): T;
     /**
      * Retrieve the last Element from the Arrayable
-     * @returns {IsElement}
      */
     get last(): T;
     /**
      * Return the length of the list.
-     * @returns {number}
      */
     get length(): number;
     /**
      * Insert a new node (or data) after a node.
-     * @param {IsElement} node
-     * @param {IsElement|*} newNode
-     * @returns {IsArrayable}
+     * @param node
+     * @param newNode
      */
     insertAfter(node: T, newNode: T | any): IsArrayable<any>;
     /**
      * Insert a new node (or data) before a node.
-     * @param {IsElement} node
-     * @param {IsElement|*} newNode
-     * @returns {IsArrayable}
+     * @param node
+     * @param newNode
      */
     insertBefore(node: T, newNode: T | any): IsArrayable<any>;
     /**
      * Add a node (or data) after the given (or last) node in the list.
-     * @param {IsElement|*} node
-     * @param {IsElement} after
-     * @returns {IsArrayable}
+     * @param node
+     * @param after
      */
     append(node: T | any, after?: T): IsArrayable<any>;
     /**
      * Add a node (or data) before the given (or first) node in the list.
-     * @param {IsElement|*} node
-     * @param {IsElement} before
-     * @returns {IsArrayable}
+     * @param node
+     * @param before
      */
     prepend(node: T | any, before?: T): IsArrayable<any>;
     /**
      * Remove an element from this arrayable.
-     * @param {IsElement} node
-     * @return {IsElement}
+     * @param node
      */
     remove(node: T): T;
     /**
      * Retrieve an element item from this list by numeric index, otherwise return null.
-     * @param {number} index
-     * @return {IsElement|null}
+     * @param index
      */
     item(index: number): T | null;
     /**
      * Be able to run forEach on this Arrayable to iterate over the elements.
-     * @param {forEachCallback} callback
-     * @param {IsArrayable} thisArg
-     * @returns {IsArrayable}
+     * @param callback
+     * @param thisArg
      */
     forEach(callback: forEachCallback, thisArg?: IsArrayable<any>): IsArrayable<any>;
     /**
      * Be able to iterate over this class.
-     * @returns {Iterator}
      */
     [Symbol.iterator](): Iterator<T>;
 }

package/dist/recipes/IsQueue.d.ts

@@ -1,8 +1,5 @@
 /**
- * @file Queue recipe.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
+ * Queue recipe.
  */
 /**
  * Define a first-in-first-out queue: items are added to the back (enqueue) and taken from the front (dequeue).
@@ -11,27 +8,25 @@
 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
+     * @returns 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
+     * @param 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
+     * @returns 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/IsScopedCollection.d.ts

@@ -0,0 +1,27 @@
+/**
+ * ScopedCollection recipe.
+ */
+/**
+ * Define a keyed collection partitioned by scope: every scope has its own independent key space, and a scope
+ * that is no longer referenced anywhere else takes its whole key space with it.
+ */
+export interface IsScopedCollection<Scope extends object = object, Key = any, Value = any> {
+    /**
+     * Remove a key from a scope's key space.
+     * @returns Whether a value was actually removed
+     */
+    delete: (scope: Scope, key: Key) => boolean;
+    /**
+     * Look up a value by key within a scope.
+     * @returns The value, or undefined when the scope or key is not present
+     */
+    get: (scope: Scope, key: Key) => Value | undefined;
+    /**
+     * Check whether a key exists within a scope.
+     */
+    has: (scope: Scope, key: Key) => boolean;
+    /**
+     * Store a value under a key within a scope.
+     */
+    set: (scope: Scope, key: Key, value: Value) => void;
+}

package/dist/recipes/IsScopedCollection.js

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

package/dist/recipes/IsScopedCollection.min.js

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

package/dist/recipes/IsStack.d.ts

@@ -1,8 +1,5 @@
 /**
- * @file Stack recipe.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
+ * Stack recipe.
  */
 /**
  * Define a last-in-first-out stack: items are added to the top (push) and taken from the top (pop).
@@ -10,27 +7,25 @@
 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
+     * @returns 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
+     * @returns 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
+     * @param data The item to add
      */
     push: (data: T) => void;
     /**
      * Count the items in the stack.
-     * @return {number}
      */
     size: () => number;
 }

package/dist/recipes/IsTreeNode.d.ts

@@ -23,7 +23,7 @@ export interface IsTreeNode extends IsDoubleLinker {
     children: IsArrayable<IsTreeNode> | null;
     /**
      * Create the children for this tree from an array.
-     * @param {Array} children
+     * @param children
      */
     childrenFromArray(children: Array<any> | null): LinkedTreeList;
 }

package/dist/recipes/LinkerIterator.d.ts

@@ -6,13 +6,13 @@ 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.
+     * @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.
-     * @return {IteratorResult<IsLinker>} The current item, or done when there are no more.
+     * @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

@@ -10,7 +10,7 @@ exports.LinkerIterator = void 0
 class LinkerIterator {
   /**
    * Create an iterator starting at the given item.
-   * @param {IsLinker} current The item to start from.
+   * @param current The item to start from.
    */
   constructor (current) {
     this.current = current
@@ -18,8 +18,8 @@ class LinkerIterator {
 
   /**
    * 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.
+   * @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 = {

package/dist/recipes/Runnable.d.ts

@@ -1,15 +1,5 @@
 /**
- * @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
+ * Runnable class recipe.
  */
 export type completeResponse = {
     success: boolean | any;
@@ -32,24 +22,21 @@ export declare class Runnable implements IsRunnable {
     data: any;
     /**
      * Instantiate a Runnable class.
-     * @param {*} [data=null] The task (a function) or the data which the task returns.
+     * @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.
-     * @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}
+     * @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

@@ -5,10 +5,7 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.Runnable = void 0
 /**
- * @file Runnable class recipe.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
+ * Runnable class recipe.
  */
 /**
  * Identify a class that can be run.
@@ -16,7 +13,7 @@ exports.Runnable = void 0
 class Runnable {
   /**
    * Instantiate a Runnable class.
-   * @param {*} [data=null] The task (a function) or the data which the task returns.
+   * @param data The task (a function) or the data which the task returns.
    */
   constructor (data = null) {
     /** The task (or data) this runnable holds. */
@@ -26,7 +23,6 @@ class Runnable {
 
   /**
    * Retrieve the data which should be formed as a task.
-   * @return {Function}
    */
   get task () {
     if (typeof this.data === 'function') {
@@ -37,7 +33,6 @@ class Runnable {
 
   /**
    * Run the runnable task.
-   * @return {*}
    */
   run () {
     return this.task()
@@ -46,8 +41,7 @@ class Runnable {
   /**
    * 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}
+   * @param thing The value to check, or nothing to check whether this class is Runnable.
    */
   static isRunnable (thing) {
     if (typeof thing === 'undefined') {

package/dist/recipes/TreeLinkerIterator.d.ts

@@ -7,14 +7,14 @@ export declare class TreeLinkerIterator implements Iterator<IsTreeNode> {
     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.
+     * @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.
-     * @return {IteratorResult<IsTreeNode>} The current item, or done when there are no more.
+     * @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
-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 {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,8 +1,5 @@
 /**
- * @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
+ * sample classes which follow a pattern (have certain members or methods).
  */
 import { ArrayIterator } from './ArrayIterator';
 import { Runnable } from './Runnable';

package/dist/recipes/recipes.js

@@ -1,22 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.recipes = void 0
-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>
- * @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

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

package/dist/services/parseTree.js

@@ -1,24 +1,23 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.parseTree = void 0
-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
- * @param {forEachCallback} callback
- * @returns {IsArrayable<IsTreeNode>}
- */
-const parseTree = (tree, callback) => {
-  let index = 0
-  let current = tree.rootParent
-  while (current !== null) {
-    callback(current, index, tree)
-    current = (0, _parseTreeNext.parseTreeNext)(current)
-    ++index
-  }
-  return tree
-}
-exports.parseTree = parseTree
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.parseTree = void 0
+const _parseTreeNext = require('./parseTreeNext')
+/**
+ * Loop over all the nodes in a tree starting from left and apply a callback for each
+ * @param tree
+ * @param callback
+ */
+const parseTree = (tree, callback) => {
+  let index = 0
+  let current = tree.rootParent
+  while (current !== null) {
+    callback(current, index, tree)
+    current = (0, _parseTreeNext.parseTreeNext)(current)
+    ++index
+  }
+  return tree
+}
+exports.parseTree = parseTree