collect-your-stuff 2.1.1 → 2.2.0

package/dist/recipes/DoubleLinkerIterator.js

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

package/dist/recipes/IsArrayable.d.ts

@@ -1,105 +1,85 @@
-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.
- */
-export interface IsArrayable<T extends IsElement> {
-    /**
-     * Obnoxious typescript won't let me use typeof this class
-     * @property {IsArrayable} classType
-     */
-    classType: any;
-    /**
-     * @property {Array<IsElement> | IsElement | null} innerList
-     */
-    innerList: Array<T> | T | null;
-    /**
-     * @private {boolean} initialized
-     */
-    initialized: boolean;
-    /**
-     * Initialize the inner list, should only run once.
-     * @param {IsArrayable|Array} initialList
-     * @return {IsArrayable}
-     */
-    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}
-     */
-    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}
-     */
-    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}
-     */
-    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}
-     */
-    prepend(node: T | any, before?: T): IsArrayable<any>;
-    /**
-     * Remove an element from this arrayable.
-     * @param {IsElement} node
-     * @return {IsElement}
-     */
-    remove(node: T): T;
-    /**
-     * Retrieve an element item from this list by numeric index, otherwise return null.
-     * @param {number} index
-     * @return {IsElement|null}
-     */
-    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}
-     */
-    forEach(callback: forEachCallback, thisArg?: IsArrayable<any>): IsArrayable<any>;
-    /**
-     * Be able to iterate over this class.
-     * @returns {Iterator}
-     */
-    [Symbol.iterator](): Iterator<T>;
-}
+import { IsElement } from './IsElement';
+export type forEachCallback = (element: IsElement, index?: number, thisArg?: IsArrayable<any>) => void;
+/**
+ * Arrayable represents a collection stored as Elements.
+ */
+export interface IsArrayable<T extends IsElement> {
+    /**
+     * Obnoxious typescript won't let me use typeof this class
+     * @property {IsArrayable} classType
+     */
+    classType: any;
+    /**
+     * @property {Array<IsElement> | IsElement | null} innerList
+     */
+    innerList: Array<T> | T | null;
+    /**
+     * @private {boolean} initialized
+     */
+    initialized: boolean;
+    /**
+     * Initialize the inner list, should only run once.
+     * @param initialList
+     */
+    initialize(initialList: Array<T> | T): IsArrayable<any>;
+    /**
+     * Retrieve a copy of the innerList used.
+     */
+    get list(): Array<IsElement> | IsElement;
+    /**
+     * Retrieve the first Element from the Arrayable
+     */
+    get first(): T;
+    /**
+     * Retrieve the last Element from the Arrayable
+     */
+    get last(): T;
+    /**
+     * Return the length of the list.
+     */
+    get length(): number;
+    /**
+     * Insert a new node (or data) after a node.
+     * @param node
+     * @param newNode
+     */
+    insertAfter(node: T, newNode: T | any): IsArrayable<any>;
+    /**
+     * Insert a new node (or data) before a node.
+     * @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 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 node
+     * @param before
+     */
+    prepend(node: T | any, before?: T): IsArrayable<any>;
+    /**
+     * Remove an element from this arrayable.
+     * @param node
+     */
+    remove(node: T): T;
+    /**
+     * Retrieve an element item from this list by numeric index, otherwise return null.
+     * @param index
+     */
+    item(index: number): T | null;
+    /**
+     * Be able to run forEach on this Arrayable to iterate over the elements.
+     * @param callback
+     * @param thisArg
+     */
+    forEach(callback: forEachCallback, thisArg?: IsArrayable<any>): IsArrayable<any>;
+    /**
+     * Be able to iterate over this class.
+     */
+    [Symbol.iterator](): Iterator<T>;
+}

package/dist/recipes/IsArrayable.js

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

package/dist/recipes/IsDoubleLinker.d.ts

@@ -1,14 +1,14 @@
-import { IsLinker } from './IsLinker';
-/**
- * Define the common attributes of a DoubleLinker used in a linking structure chained with 'next' and sometimes 'prev'.
- */
-export interface IsDoubleLinker extends IsLinker {
-    /**
-     * @property {IsDoubleLinker} [next=null]
-     */
-    next: IsDoubleLinker;
-    /**
-     * @property {IsDoubleLinker} [prev=null]
-     */
-    prev: IsDoubleLinker;
-}
+import { IsLinker } from './IsLinker';
+/**
+ * Define the common attributes of a DoubleLinker used in a linking structure chained with 'next' and sometimes 'prev'.
+ */
+export interface IsDoubleLinker extends IsLinker {
+    /**
+     * @property {IsDoubleLinker} [next=null]
+     */
+    next: IsDoubleLinker;
+    /**
+     * @property {IsDoubleLinker} [prev=null]
+     */
+    prev: IsDoubleLinker;
+}

package/dist/recipes/IsDoubleLinker.js

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

package/dist/recipes/IsElement.d.ts

@@ -1,14 +1,14 @@
-/**
- * Define the common attributes of an Element in a list.
- */
-export interface IsElement {
-    /**
-     * Obnoxious typescript won't let me use typeof this class
-     * @property {IsElement} classType
-     */
-    classType: any;
-    /**
-     * @property {*} data
-     */
-    data: any;
-}
+/**
+ * Define the common attributes of an Element in a list.
+ */
+export interface IsElement {
+    /**
+     * Obnoxious typescript won't let me use typeof this class
+     * @property {IsElement} classType
+     */
+    classType: any;
+    /**
+     * @property {*} data
+     */
+    data: any;
+}

package/dist/recipes/IsElement.js

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

package/dist/recipes/IsLinker.d.ts

@@ -1,10 +1,10 @@
-import { IsElement } from './IsElement';
-/**
- * Define the common attributes of a Linker used in a linking structure chained with 'next' (and sometimes 'prev').
- */
-export interface IsLinker extends IsElement {
-    /**
-     * @property {IsLinker} [next=null]
-     */
-    next: IsLinker;
-}
+import { IsElement } from './IsElement';
+/**
+ * Define the common attributes of a Linker used in a linking structure chained with 'next' (and sometimes 'prev').
+ */
+export interface IsLinker extends IsElement {
+    /**
+     * @property {IsLinker} [next=null]
+     */
+    next: IsLinker;
+}

package/dist/recipes/IsLinker.js

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

package/dist/recipes/IsQueue.d.ts

@@ -1,37 +1,32 @@
-/**
- * @file Queue recipe.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
- */
-/**
- * Define a first-in-first-out queue: items are added to the back (enqueue) and taken from the front (dequeue).
- * This is the shape which si-funciona's queueManager / queueTimeout expect of a queue.
- */
-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
-     */
-    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
-     */
-    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
-     */
-    peek: () => T | null;
-    /**
-     * Count the items in the queue.
-     * @return {number}
-     */
-    size: () => number;
-}
+/**
+ * Queue recipe.
+ */
+/**
+ * Define a first-in-first-out queue: items are added to the back (enqueue) and taken from the front (dequeue).
+ * This is the shape which si-funciona's queueManager / queueTimeout expect of a queue.
+ */
+export interface IsQueue<T = any> {
+    /**
+     * Take the item from the front of the queue.
+     * @returns The item, or null when the queue is empty
+     */
+    dequeue: () => T | null;
+    /**
+     * Check whether the queue has no items.
+     */
+    empty: () => boolean;
+    /**
+     * Add an item to the back of the queue.
+     * @param data The item to add
+     */
+    enqueue: (data: T) => void;
+    /**
+     * Look at the item at the front of the queue, without removing it.
+     * @returns The item, or null when the queue is empty
+     */
+    peek: () => T | null;
+    /**
+     * Count the items in the queue.
+     */
+    size: () => number;
+}

package/dist/recipes/IsQueue.js

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

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,36 +1,31 @@
-/**
- * @file Stack recipe.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @memberOf module:collect-your-stuff
- */
-/**
- * Define a last-in-first-out stack: items are added to the top (push) and taken from the top (pop).
- */
-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
-     */
-    peek: () => T | null;
-    /**
-     * Take the item from the top of the stack.
-     * @return {T|null} 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
-     */
-    push: (data: T) => void;
-    /**
-     * Count the items in the stack.
-     * @return {number}
-     */
-    size: () => number;
-}
+/**
+ * Stack recipe.
+ */
+/**
+ * Define a last-in-first-out stack: items are added to the top (push) and taken from the top (pop).
+ */
+export interface IsStack<T = any> {
+    /**
+     * Check whether the stack has no items.
+     */
+    empty: () => boolean;
+    /**
+     * Look at the item on the top of the stack, without removing it.
+     * @returns The item, or null when the stack is empty
+     */
+    peek: () => T | null;
+    /**
+     * Take the item from the top of the stack.
+     * @returns The item, or null when the stack is empty
+     */
+    pop: () => T | null;
+    /**
+     * Add an item to the top of the stack.
+     * @param data The item to add
+     */
+    push: (data: T) => void;
+    /**
+     * Count the items in the stack.
+     */
+    size: () => number;
+}

package/dist/recipes/IsStack.js

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

package/dist/recipes/IsTree.d.ts

@@ -1,11 +1,11 @@
-import { IsTreeNode } from './IsTreeNode';
-import { IsArrayable } from './IsArrayable';
-/**
- * Arrayable represents a collection stored as Elements.
- */
-export interface IsTree extends IsArrayable<IsTreeNode> {
-    /**
-     * @property {IsTreeNode} rootParent
-     */
-    rootParent: IsTreeNode;
-}
+import { IsTreeNode } from './IsTreeNode';
+import { IsArrayable } from './IsArrayable';
+/**
+ * Arrayable represents a collection stored as Elements.
+ */
+export interface IsTree extends IsArrayable<IsTreeNode> {
+    /**
+     * @property {IsTreeNode} rootParent
+     */
+    rootParent: IsTreeNode;
+}

package/dist/recipes/IsTree.js

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