collect-your-stuff 1.2.6 → 1.2.8

package/dist/recipes/IsArrayable.d.ts

@@ -1,105 +1,105 @@
-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';
+/**
+ * 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>;
+}

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/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
+})

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 {Array} 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,9 +1,9 @@
-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;
-    constructor(current: IsLinker);
-    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;
+    constructor(current: IsLinker);
+    next(value?: any): IteratorResult<IsLinker>;
+}

package/dist/recipes/LinkerIterator.js

@@ -1,24 +1,24 @@
-'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 {
-  constructor (current) {
-    this.current = current
-  }
-
-  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 {
+  constructor (current) {
+    this.current = current
+  }
+
+  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,54 +1,54 @@
-/**
- * @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 {
-    data: any;
-    /**
-     * Instantiate a Runnable class.
-     * @param {*} data
-     */
-    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
-     * @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 {
+    data: any;
+    /**
+     * Instantiate a Runnable class.
+     * @param {*} data
+     */
+    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
+     * @return {boolean}
+     */
+    static isRunnable(thing: any): boolean;
+}