collect-your-stuff 1.2.6 → 1.2.8

package/dist/collections/linked-tree-list/TreeLinker.d.ts

@@ -1,63 +1,63 @@
-/**
- * @file doubly linked tree node.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { IsArrayable } from '../../recipes/IsArrayable';
-import { IsTreeNode } from '../../recipes/IsTreeNode';
-import { IsTree } from '../../recipes/IsTree';
-/**
- * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
- * @extends DoubleLinker
- */
-export declare class TreeLinker implements IsTreeNode {
-    readonly classType: typeof TreeLinker;
-    data: any;
-    next: IsTreeNode | null;
-    prev: IsTreeNode | null;
-    parent: IsTreeNode;
-    children: IsArrayable<IsTreeNode>;
-    /**
-     * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
-     * @param {Object} [settings={}]
-     * @param {*} [settings.data=null] The data to be stored in this tree node
-     * @param {TreeLinker} [settings.next=null] The reference to the next linker if any
-     * @param {TreeLinker} [settings.prev=null] The reference to the previous linker if any
-     * @param {LinkedTreeList} [settings.children=null] The references to child linkers if any
-     * @param {TreeLinker} [settings.parent=null] The reference to a parent linker if any
-     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
-     */
-    constructor({ data, next, prev, children, parent, listClass }?: {
-        data?: any;
-        next?: IsTreeNode;
-        prev?: IsTreeNode;
-        children?: Array<any>;
-        parent?: IsTreeNode;
-        listClass?: any;
-    });
-    /**
-     * Create the children for this tree from an array.
-     * @param {Array|null} children Provide an array of data / linker references to be children of this tree node.
-     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
-     * @return {LinkedTreeList|null}
-     */
-    childrenFromArray(children?: Array<any> | null, listClass?: any): IsTree | any;
-    /**
-     * Make a new DoubleLinker from the data given if it is not already a valid Linker.
-     * @param {TreeLinker|*} linker Return a valid TreeLinker instance from given data, or even an already valid one.
-     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
-     * @return {TreeLinker}
-     */
-    static make: (linker: TreeLinker | any, classType?: any) => IsTreeNode | any;
-    /**
-     * Convert an array into DoubleLinker instances, return the head and tail DoubleLinkers.
-     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of tree-linkers.
-     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
-     * @returns {{head: TreeLinker, tail: TreeLinker}}
-     */
-    static fromArray: (values?: Array<any>, classType?: any) => {
-        head: TreeLinker | any;
-        tail: TreeLinker | any;
-    };
-}
+/**
+ * @file doubly linked tree node.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+import { IsArrayable } from '../../recipes/IsArrayable';
+import { IsTreeNode } from '../../recipes/IsTreeNode';
+import { IsTree } from '../../recipes/IsTree';
+/**
+ * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
+ * @extends DoubleLinker
+ */
+export declare class TreeLinker implements IsTreeNode {
+    readonly classType: typeof TreeLinker;
+    data: any;
+    next: IsTreeNode | null;
+    prev: IsTreeNode | null;
+    parent: IsTreeNode;
+    children: IsArrayable<IsTreeNode>;
+    /**
+     * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
+     * @param {Object} [settings={}]
+     * @param {*} [settings.data=null] The data to be stored in this tree node
+     * @param {TreeLinker} [settings.next=null] The reference to the next linker if any
+     * @param {TreeLinker} [settings.prev=null] The reference to the previous linker if any
+     * @param {LinkedTreeList} [settings.children=null] The references to child linkers if any
+     * @param {TreeLinker} [settings.parent=null] The reference to a parent linker if any
+     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
+     */
+    constructor({ data, next, prev, children, parent, listClass }?: {
+        data?: any;
+        next?: IsTreeNode;
+        prev?: IsTreeNode;
+        children?: Array<any>;
+        parent?: IsTreeNode;
+        listClass?: any;
+    });
+    /**
+     * Create the children for this tree from an array.
+     * @param {Array|null} children Provide an array of data / linker references to be children of this tree node.
+     * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
+     * @return {LinkedTreeList|null}
+     */
+    childrenFromArray(children?: Array<any> | null, listClass?: any): IsTree | any;
+    /**
+     * Make a new DoubleLinker from the data given if it is not already a valid Linker.
+     * @param {TreeLinker|*} linker Return a valid TreeLinker instance from given data, or even an already valid one.
+     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
+     * @return {TreeLinker}
+     */
+    static make: (linker: TreeLinker | any, classType?: any) => IsTreeNode | any;
+    /**
+     * Convert an array into DoubleLinker instances, return the head and tail DoubleLinkers.
+     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of tree-linkers.
+     * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
+     * @returns {{head: TreeLinker, tail: TreeLinker}}
+     */
+    static fromArray: (values?: Array<any>, classType?: any) => {
+        head: TreeLinker | any;
+        tail: TreeLinker | any;
+    };
+}

package/dist/collections/linked-tree-list/TreeLinker.js

@@ -1,92 +1,79 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.TreeLinker = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.map.js')
-var _DoubleLinker = require('../doubly-linked-list/DoubleLinker')
-var _LinkedTreeList = require('./LinkedTreeList')
-/**
- * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
- * @extends DoubleLinker
- */
-class TreeLinker {
-  /**
-   * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
-   * @param {Object} [settings={}]
-   * @param {*} [settings.data=null] The data to be stored in this tree node
-   * @param {TreeLinker} [settings.next=null] The reference to the next linker if any
-   * @param {TreeLinker} [settings.prev=null] The reference to the previous linker if any
-   * @param {LinkedTreeList} [settings.children=null] The references to child linkers if any
-   * @param {TreeLinker} [settings.parent=null] The reference to a parent linker if any
-   * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
-   */
-  constructor () {
-    const _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {}
-    const _ref$data = _ref.data
-    const data = _ref$data === void 0 ? null : _ref$data
-    const _ref$next = _ref.next
-    const next = _ref$next === void 0 ? null : _ref$next
-    const _ref$prev = _ref.prev
-    const prev = _ref$prev === void 0 ? null : _ref$prev
-    const _ref$children = _ref.children
-    const children = _ref$children === void 0 ? null : _ref$children
-    const _ref$parent = _ref.parent
-    const parent = _ref$parent === void 0 ? null : _ref$parent
-    const _ref$listClass = _ref.listClass
-    const listClass = _ref$listClass === void 0 ? _LinkedTreeList.LinkedTreeList : _ref$listClass
-    this.classType = TreeLinker
-    this.data = null
-    this.next = null
-    this.prev = null
-    this.parent = null
-    this.children = null
-    this.data = data
-    this.next = next
-    this.prev = prev
-    this.parent = parent
-    this.children = this.childrenFromArray(children, listClass)
-  }
-
-  /**
-   * Create the children for this tree from an array.
-   * @param {Array|null} children Provide an array of data / linker references to be children of this tree node.
-   * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
-   * @return {LinkedTreeList|null}
-   */
-  childrenFromArray () {
-    const children = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
-    const listClass = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _LinkedTreeList.LinkedTreeList
-    if (children === null) {
-      return null
-    }
-    // Creates a linked-tree-list to store the children.
-    return listClass.fromArray(children.map(child => Object.assign({}, child, {
-      parent: this
-    })), this.classType)
-  }
-}
-/**
- * Make a new DoubleLinker from the data given if it is not already a valid Linker.
- * @param {TreeLinker|*} linker Return a valid TreeLinker instance from given data, or even an already valid one.
- * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
- * @return {TreeLinker}
- */
-exports.TreeLinker = TreeLinker
-TreeLinker.make = function (linker) {
-  const classType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : TreeLinker
-  return _DoubleLinker.DoubleLinker.make(linker, classType)
-}
-/**
- * Convert an array into DoubleLinker instances, return the head and tail DoubleLinkers.
- * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of tree-linkers.
- * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
- * @returns {{head: TreeLinker, tail: TreeLinker}}
- */
-TreeLinker.fromArray = function () {
-  const values = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
-  const classType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : TreeLinker
-  return _DoubleLinker.DoubleLinker.fromArray(values, classType)
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.TreeLinker = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.map.js')
+var _DoubleLinker = require('../doubly-linked-list/DoubleLinker')
+var _LinkedTreeList = require('./LinkedTreeList')
+/**
+ * TreeLinker represents a node in a LinkedTreeList having a parent (or root) and child nodes.
+ * @extends DoubleLinker
+ */
+class TreeLinker {
+  /**
+   * Create the new TreeLinker instance, provide the data and optionally set references for next, prev, parent, or children.
+   * @param {Object} [settings={}]
+   * @param {*} [settings.data=null] The data to be stored in this tree node
+   * @param {TreeLinker} [settings.next=null] The reference to the next linker if any
+   * @param {TreeLinker} [settings.prev=null] The reference to the previous linker if any
+   * @param {LinkedTreeList} [settings.children=null] The references to child linkers if any
+   * @param {TreeLinker} [settings.parent=null] The reference to a parent linker if any
+   * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
+   */
+  constructor ({
+    data = null,
+    next = null,
+    prev = null,
+    children = null,
+    parent = null,
+    listClass = _LinkedTreeList.LinkedTreeList
+  } = {}) {
+    this.classType = TreeLinker
+    this.data = null
+    this.next = null
+    this.prev = null
+    this.parent = null
+    this.children = null
+    this.data = data
+    this.next = next
+    this.prev = prev
+    this.parent = parent
+    this.children = this.childrenFromArray(children, listClass)
+  }
+
+  /**
+   * Create the children for this tree from an array.
+   * @param {Array|null} children Provide an array of data / linker references to be children of this tree node.
+   * @param {IsArrayable<IsTreeNode>} listClass Give the type of list to use for storing the children
+   * @return {LinkedTreeList|null}
+   */
+  childrenFromArray (children = null, listClass = _LinkedTreeList.LinkedTreeList) {
+    if (children === null) {
+      return null
+    }
+    // Creates a linked-tree-list to store the children.
+    return listClass.fromArray(children.map(child => Object.assign({}, child, {
+      parent: this
+    })), this.classType)
+  }
+}
+/**
+ * Make a new DoubleLinker from the data given if it is not already a valid Linker.
+ * @param {TreeLinker|*} linker Return a valid TreeLinker instance from given data, or even an already valid one.
+ * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
+ * @return {TreeLinker}
+ */
+exports.TreeLinker = TreeLinker
+TreeLinker.make = (linker, classType = TreeLinker) => {
+  return _DoubleLinker.DoubleLinker.make(linker, classType)
+}
+/**
+ * Convert an array into DoubleLinker instances, return the head and tail DoubleLinkers.
+ * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of tree-linkers.
+ * @param {IsTreeNode} [classType=TreeLinker] Provide the type of IsTreeNode to use.
+ * @returns {{head: TreeLinker, tail: TreeLinker}}
+ */
+TreeLinker.fromArray = (values = [], classType = TreeLinker) => _DoubleLinker.DoubleLinker.fromArray(values, classType)

package/dist/collections/linked-tree-list/TreeLinker.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TreeLinker=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _DoubleLinker=require("../doubly-linked-list/DoubleLinker"),_LinkedTreeList=require("./LinkedTreeList");class TreeLinker{constructor(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},r=e.data,i=void 0===r?null:r,n=e.next,t=void 0===n?null:n,l=e.prev,s=void 0===l?null:l,o=e.children,u=void 0===o?null:o,d=e.parent,a=void 0===d?null:d,L=e.listClass,h=void 0===L?_LinkedTreeList.LinkedTreeList:L;this.classType=TreeLinker,this.data=null,this.next=null,this.prev=null,this.parent=null,this.children=null,this.data=i,this.next=t,this.prev=s,this.parent=a,this.children=this.childrenFromArray(u,h)}childrenFromArray(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null,r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:_LinkedTreeList.LinkedTreeList;return null===e?null:r.fromArray(e.map((e=>Object.assign({},e,{parent:this}))),this.classType)}}exports.TreeLinker=TreeLinker,TreeLinker.make=function(e){let r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:TreeLinker;return _DoubleLinker.DoubleLinker.make(e,r)},TreeLinker.fromArray=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:TreeLinker;return _DoubleLinker.DoubleLinker.fromArray(e,r)};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TreeLinker=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _DoubleLinker=require("../doubly-linked-list/DoubleLinker"),_LinkedTreeList=require("./LinkedTreeList");class TreeLinker{constructor({data:e=null,next:r=null,prev:i=null,children:n=null,parent:t=null,listClass:l=_LinkedTreeList.LinkedTreeList}={}){this.classType=TreeLinker,this.data=null,this.next=null,this.prev=null,this.parent=null,this.children=null,this.data=e,this.next=r,this.prev=i,this.parent=t,this.children=this.childrenFromArray(n,l)}childrenFromArray(e=null,r=_LinkedTreeList.LinkedTreeList){return null===e?null:r.fromArray(e.map((e=>Object.assign({},e,{parent:this}))),this.classType)}}exports.TreeLinker=TreeLinker,TreeLinker.make=(e,r=TreeLinker)=>_DoubleLinker.DoubleLinker.make(e,r),TreeLinker.fromArray=(e=[],r=TreeLinker)=>_DoubleLinker.DoubleLinker.fromArray(e,r);

package/dist/collections/queue/Queue.d.ts

@@ -1,63 +1,63 @@
-/**
- * @file queue
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { Queueable } from './Queueable';
-import { IsArrayable } from '../../recipes/IsArrayable';
-import { IsLinker } from '../../recipes/IsLinker';
-import { completeResponse } from '../../recipes/Runnable';
-/**
- * Maintain a series of queued items.
- */
-export declare class Queue {
-    queuedList: IsArrayable<any>;
-    private listClass;
-    private queueableClass;
-    /**
-     * Instantiate the queue with the given queue list.
-     * @param {Iterable|LinkedList} queuedList Give the list of queueables to start in this queue.
-     * @param {IsArrayable} listClass
-     * @param {Queueable} queueableClass
-     */
-    constructor(queuedList?: IsArrayable<any>, listClass?: any, queueableClass?: typeof Queueable);
-    /**
-     * Take a queued task from the front of the queue and run it if ready.
-     * @return {completeResponse|*}
-     */
-    dequeue(): completeResponse | any;
-    /**
-     * Return true if the queue is empty (there are no tasks in the queue list)
-     * @return {boolean}
-     */
-    empty(): boolean;
-    /**
-     * Add a queued task to the end of the queue
-     * @param {Queueable} queueable Add a new queueable to the end of the queue
-     */
-    enqueue(queueable: Queueable): void;
-    /**
-     * Take a look at the next queued task
-     * @return {Queueable}
-     */
-    peek(): IsLinker;
-    /**
-     * Remove the next queued item and return it.
-     * @return {Queueable|null}
-     */
-    remove(): Queueable | null;
-    /**
-     * Get the length of the current queue.
-     * @return {number}
-     */
-    size(): number;
-    /**
-     * Convert an array to a Queue.
-     * @param {Array} values An array of values which will be converted to queueables in this queue
-     * @param {Queueable} queueableClass The class to use for each queueable
-     * @param {Queue|Iterable} listClass The class to use to manage the queueables
-     * @returns {Queue}
-     */
-    static fromArray: (values?: Array<any>, queueableClass?: typeof Queueable, listClass?: any) => Queue;
-}
+/**
+ * @file queue
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+import { Queueable } from './Queueable';
+import { IsArrayable } from '../../recipes/IsArrayable';
+import { IsLinker } from '../../recipes/IsLinker';
+import { completeResponse } from '../../recipes/Runnable';
+/**
+ * Maintain a series of queued items.
+ */
+export declare class Queue {
+    queuedList: IsArrayable<any>;
+    private listClass;
+    private queueableClass;
+    /**
+     * Instantiate the queue with the given queue list.
+     * @param {Iterable|LinkedList} queuedList Give the list of queueables to start in this queue.
+     * @param {IsArrayable} listClass
+     * @param {Queueable} queueableClass
+     */
+    constructor(queuedList?: IsArrayable<any>, listClass?: any, queueableClass?: typeof Queueable);
+    /**
+     * Take a queued task from the front of the queue and run it if ready.
+     * @return {completeResponse|*}
+     */
+    dequeue(): completeResponse | any;
+    /**
+     * Return true if the queue is empty (there are no tasks in the queue list)
+     * @return {boolean}
+     */
+    empty(): boolean;
+    /**
+     * Add a queued task to the end of the queue
+     * @param {Queueable} queueable Add a new queueable to the end of the queue
+     */
+    enqueue(queueable: Queueable): void;
+    /**
+     * Take a look at the next queued task
+     * @return {Queueable}
+     */
+    peek(): IsLinker;
+    /**
+     * Remove the next queued item and return it.
+     * @return {Queueable|null}
+     */
+    remove(): Queueable | null;
+    /**
+     * Get the length of the current queue.
+     * @return {number}
+     */
+    size(): number;
+    /**
+     * Convert an array to a Queue.
+     * @param {Array} values An array of values which will be converted to queueables in this queue
+     * @param {Queueable} queueableClass The class to use for each queueable
+     * @param {Queue|Iterable} listClass The class to use to manage the queueables
+     * @returns {Queue}
+     */
+    static fromArray: (values?: Array<any>, queueableClass?: typeof Queueable, listClass?: any) => Queue;
+}