collect-your-stuff 1.1.0 → 1.1.2

package/dist/collections/linked-list/LinkedList.js

@@ -1,232 +1,241 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-var _Linker = _interopRequireDefault(require('./Linker'))
-var _LinkerIterator = _interopRequireDefault(require('../../recipes/LinkerIterator'))
-var _Arrayable = _interopRequireDefault(require('../arrayable/Arrayable'))
-function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
-/**
- * LinkedList represents a collection stored as a LinkedList with next references.
- * @extends Arrayable
- */
-class LinkedList {
-  /**
-   * Create the new LinkedList instance.
-   */
-  constructor () {
-    this.classType = null
-    this.innerList = null
-    this.initialized = false
-    this.classType = LinkedList
-  }
-
-  /**
-   * Initialize the inner list, should only run once.
-   * @param {Linker|Array} initialList Give the list of linkers to start in this linked-list.
-   * @return {LinkedList}
-   */
-  initialize (initialList) {
-    return _Arrayable.default.prototype.initialize.call(this, initialList)
-  }
-
-  /**
-   * Retrieve a copy of the innerList used.
-   * @returns {Linker}
-   */
-  get list () {
-    return this.innerList
-  }
-
-  /**
-   * Retrieve the first Linker in the list.
-   * @returns {Linker}
-   */
-  get first () {
-    return this.innerList
-  }
-
-  /**
-   * Retrieve the last Linker in the list.
-   * @returns {Linker}
-   */
-  get last () {
-    let tail = this.innerList
-    let next = tail.next
-    while (next !== null) {
-      tail = next
-      next = tail.next
-    }
-    return tail
-  }
-
-  /**
-   * Return the length of the list.
-   * @returns {number}
-   */
-  get length () {
-    let current = this.first
-    let length = 0
-    while (current !== null) {
-      ++length
-      current = current.next
-    }
-    return length
-  }
-
-  /**
-   * Insert a new node (or data) after a node.
-   * @param {Linker|*} node The existing node as reference
-   * @param {Linker|*} newNode The new node to go after the existing node
-   * @returns {LinkedList}
-   */
-  insertAfter (node, newNode) {
-    newNode = node.classType.make(newNode)
-    // Ensure the next reference of this node is assigned to the new node
-    newNode.next = node.next
-    // Then set this node's next reference to the new node
-    node.next = newNode
-    return this
-  }
-
-  /**
-   * Insert a new node (or data) before a node.
-   * @param {Linker|*} node The existing node as reference
-   * @param {Linker|*} newNode The new node to go before the existing node
-   * @returns {LinkedList}
-   */
-  insertBefore (node, newNode) {
-    newNode = node.classType.make(newNode)
-    let prevNode = null
-    let currentNode = this.first
-    while (currentNode !== node) {
-      prevNode = currentNode
-      currentNode = currentNode.next
-    }
-    // The new node will reference this node as next
-    newNode.next = node
-    if (prevNode) {
-      // Ensure the next reference of the previous node is assigned to the new node
-      prevNode.next = newNode
-    }
-    if (node === this.first) {
-      this.innerList = newNode
-    }
-    return this
-  }
-
-  /**
-   * Add a node (or data) after the given (or last) node in the list.
-   * @param {Linker|*} node The new node to add to the end of the list
-   * @param {Linker} after The existing last node
-   * @returns {Linker}
-   */
-  append (node) {
-    const after = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.last
-    return this.insertAfter(after, node)
-  }
-
-  /**
-   * Add a node (or data) before the given (or first) node in the list.
-   * @param {Linker|*} node The new node to add to the start of the list
-   * @param {Linker} before The existing first node
-   * @returns {Linker}
-   */
-  prepend (node) {
-    const before = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.first
-    return this.insertBefore(before, node)
-  }
-
-  /**
-   * Remove a linker from this linked list.
-   * @param {Linker} node The node we wish to remove (and it will be returned after removal)
-   * @return {Linker}
-   */
-  remove (node) {
-    let prevNode = null
-    let currentNode = this.first
-    while (currentNode !== node) {
-      prevNode = currentNode
-      currentNode = currentNode.next
-    }
-    if (prevNode) {
-      // Ensure the next reference of the previous node skips over the removed node
-      prevNode.next = node.next
-    }
-    if (node === this.first) {
-      // Update list head to point to next if it was this node
-      this.innerList = node.next
-    }
-    return node
-  }
-
-  /**
-   * Retrieve a Linker item from this list by numeric index, otherwise return null.
-   * @param {number} index The integer number for retrieving a node by position.
-   * @returns {Linker|null}
-   */
-  item (index) {
-    if (index >= 0) {
-      let current = this.first
-      let currentIndex = -1
-      while (++currentIndex < index && current !== null) {
-        current = current.next
-      }
-      return currentIndex === index ? current : null
-    }
-    let current = this.first
-    let currentIndex = 0
-    const calculatedIndex = this.length + index
-    if (calculatedIndex < 0) {
-      return null
-    }
-    while (currentIndex < calculatedIndex && current !== null) {
-      current = current.next
-      ++currentIndex
-    }
-    return currentIndex === calculatedIndex ? current : null
-  }
-
-  /**
-   * Be able to run forEach on this LinkedList to iterate over the linkers.
-   * @param {forEachCallback} callback The function to call for-each linker
-   * @param {LinkedList} thisArg Optional, 'this' reference
-   * @returns {LinkedList}
-   */
-  forEach (callback) {
-    const thisArg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this
-    let index = 0
-    let current = thisArg.first
-    while (current !== null) {
-      callback(current, index, thisArg)
-      current = current.next
-      ++index
-    }
-    return thisArg
-  }
-
-  /**
-   * Be able to iterate over this class.
-   * @returns {Iterator}
-   */
-  [Symbol.iterator] () {
-    return new _LinkerIterator.default(this.first)
-  }
-}
-/**
- * Convert an array to a LinkedList.
- * @param {Array} values An array of values which will be converted to linkers in this linked-list
- * @param {IsLinker} linkerClass The class to use for each linker
- * @param {IsArrayable<Linker>} [classType=LinkedList] Provide the type of IsArrayable to use.
- * @returns {LinkedList}
- */
-LinkedList.fromArray = function () {
-  const values = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
-  const linkerClass = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _Linker.default
-  const classType = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : LinkedList
-  const list = new classType()
-  return list.initialize(linkerClass.fromArray(values).head)
-}
-var _default = exports.default = LinkedList
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+var _Linker = _interopRequireDefault(require('./Linker'))
+var _LinkerIterator = _interopRequireDefault(require('../../recipes/LinkerIterator'))
+var _Arrayable = _interopRequireDefault(require('../arrayable/Arrayable'))
+function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
+/**
+ * LinkedList represents a collection stored as a LinkedList with next references.
+ * @extends Arrayable
+ */
+class LinkedList {
+  /**
+   * Create the new LinkedList instance.
+   */
+  constructor () {
+    const linkerClass = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _Linker.default
+    this.classType = LinkedList
+    this.innerList = null
+    this.initialized = false
+    this.linkerClass = linkerClass
+  }
+
+  /**
+   * Initialize the inner list, should only run once.
+   * @param {Linker|Array} initialList Give the list of linkers to start in this linked-list.
+   * @return {LinkedList}
+   */
+  initialize (initialList) {
+    return _Arrayable.default.prototype.initialize.call(this, initialList)
+  }
+
+  /**
+   * Retrieve a copy of the innerList used.
+   * @returns {Linker}
+   */
+  get list () {
+    return this.innerList
+  }
+
+  /**
+   * Retrieve the first Linker in the list.
+   * @returns {Linker}
+   */
+  get first () {
+    return this.innerList
+  }
+
+  /**
+   * Retrieve the last Linker in the list.
+   * @returns {Linker}
+   */
+  get last () {
+    let tail = this.innerList
+    if (tail === null) {
+      return null
+    }
+    let next = tail.next
+    while (next !== null) {
+      tail = next
+      next = tail.next
+    }
+    return tail
+  }
+
+  /**
+   * Return the length of the list.
+   * @returns {number}
+   */
+  get length () {
+    let current = this.first
+    let length = 0
+    while (current !== null) {
+      ++length
+      current = current.next
+    }
+    return length
+  }
+
+  /**
+   * Insert a new node (or data) after a node.
+   * @param {Linker|*} node The existing node as reference
+   * @param {Linker|*} newNode The new node to go after the existing node
+   * @returns {LinkedList}
+   */
+  insertAfter (node, newNode) {
+    newNode = this.linkerClass.make(newNode)
+    if (node !== null) {
+      // Ensure the next reference of this node is assigned to the new node
+      newNode.next = node.next
+      // Then set this node's next reference to the new node
+      node.next = newNode
+    }
+    if (!this.length) {
+      this.innerList = newNode
+    }
+    return this
+  }
+
+  /**
+   * Insert a new node (or data) before a node.
+   * @param {Linker|*} node The existing node as reference
+   * @param {Linker|*} newNode The new node to go before the existing node
+   * @returns {LinkedList}
+   */
+  insertBefore (node, newNode) {
+    newNode = this.linkerClass.make(newNode)
+    let prevNode = null
+    let currentNode = this.first
+    while (currentNode !== node) {
+      prevNode = currentNode
+      currentNode = currentNode.next
+    }
+    // The new node will reference this node as next
+    newNode.next = node
+    if (prevNode) {
+      // Ensure the next reference of the previous node is assigned to the new node
+      prevNode.next = newNode
+    }
+    if (node === this.first || node === null) {
+      this.innerList = newNode
+    }
+    return this
+  }
+
+  /**
+   * Add a node (or data) after the given (or last) node in the list.
+   * @param {Linker|*} node The new node to add to the end of the list
+   * @param {Linker} after The existing last node
+   * @returns {Linker}
+   */
+  append (node) {
+    const after = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.last
+    return this.insertAfter(after, node)
+  }
+
+  /**
+   * Add a node (or data) before the given (or first) node in the list.
+   * @param {Linker|*} node The new node to add to the start of the list
+   * @param {Linker} before The existing first node
+   * @returns {Linker}
+   */
+  prepend (node) {
+    const before = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.first
+    return this.insertBefore(before, node)
+  }
+
+  /**
+   * Remove a linker from this linked list.
+   * @param {Linker} node The node we wish to remove (and it will be returned after removal)
+   * @return {Linker}
+   */
+  remove (node) {
+    let prevNode = null
+    let currentNode = this.first
+    while (currentNode !== node) {
+      prevNode = currentNode
+      currentNode = currentNode.next
+    }
+    if (prevNode) {
+      // Ensure the next reference of the previous node skips over the removed node
+      prevNode.next = node.next
+    }
+    if (node === this.first && node !== null) {
+      // Update list head to point to next if it was this node
+      this.innerList = node.next
+    }
+    return node
+  }
+
+  /**
+   * Retrieve a Linker item from this list by numeric index, otherwise return null.
+   * @param {number} index The integer number for retrieving a node by position.
+   * @returns {Linker|null}
+   */
+  item (index) {
+    if (index >= 0) {
+      let current = this.first
+      let currentIndex = -1
+      while (++currentIndex < index && current !== null) {
+        current = current.next
+      }
+      return currentIndex === index ? current : null
+    }
+    let current = this.first
+    let currentIndex = 0
+    const calculatedIndex = this.length + index
+    if (calculatedIndex < 0) {
+      return null
+    }
+    while (currentIndex < calculatedIndex && current !== null) {
+      current = current.next
+      ++currentIndex
+    }
+    return currentIndex === calculatedIndex ? current : null
+  }
+
+  /**
+   * Be able to run forEach on this LinkedList to iterate over the linkers.
+   * @param {forEachCallback} callback The function to call for-each linker
+   * @param {LinkedList} thisArg Optional, 'this' reference
+   * @returns {LinkedList}
+   */
+  forEach (callback) {
+    const thisArg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this
+    let index = 0
+    let current = thisArg.first
+    while (current !== null) {
+      callback(current, index, thisArg)
+      current = current.next
+      ++index
+    }
+    return thisArg
+  }
+
+  /**
+   * Be able to iterate over this class.
+   * @returns {Iterator}
+   */
+  [Symbol.iterator] () {
+    return new _LinkerIterator.default(this.first)
+  }
+}
+/**
+ * Convert an array to a LinkedList.
+ * @param {Array} values An array of values which will be converted to linkers in this linked-list
+ * @param {IsLinker} linkerClass The class to use for each linker
+ * @param {IsArrayable<Linker>} [classType=LinkedList] Provide the type of IsArrayable to use.
+ * @returns {LinkedList}
+ */
+LinkedList.fromArray = function () {
+  const values = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
+  const linkerClass = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _Linker.default
+  const classType = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : LinkedList
+  const list = new classType(linkerClass)
+  return list.initialize(linkerClass.fromArray(values).head)
+}
+var _default = exports.default = LinkedList

package/dist/collections/linked-list/LinkedList.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0;var _Linker=_interopRequireDefault(require("./Linker")),_LinkerIterator=_interopRequireDefault(require("../../recipes/LinkerIterator")),_Arrayable=_interopRequireDefault(require("../arrayable/Arrayable"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}class LinkedList{constructor(){this.classType=null,this.innerList=null,this.initialized=!1,this.classType=LinkedList}initialize(e){return _Arrayable.default.prototype.initialize.call(this,e)}get list(){return this.innerList}get first(){return this.innerList}get last(){let e=this.innerList,t=e.next;for(;null!==t;)e=t,t=e.next;return e}get length(){let e=this.first,t=0;for(;null!==e;)++t,e=e.next;return t}insertAfter(e,t){return(t=e.classType.make(t)).next=e.next,e.next=t,this}insertBefore(e,t){t=e.classType.make(t);let r=null,i=this.first;for(;i!==e;)r=i,i=i.next;return t.next=e,r&&(r.next=t),e===this.first&&(this.innerList=t),this}append(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:this.last;return this.insertAfter(t,e)}prepend(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:this.first;return this.insertBefore(t,e)}remove(e){let t=null,r=this.first;for(;r!==e;)t=r,r=r.next;return t&&(t.next=e.next),e===this.first&&(this.innerList=e.next),e}item(e){if(e>=0){let t=this.first,r=-1;for(;++r<e&&null!==t;)t=t.next;return r===e?t:null}let t=this.first,r=0;const i=this.length+e;if(i<0)return null;for(;r<i&&null!==t;)t=t.next,++r;return r===i?t:null}forEach(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:this,r=0,i=t.first;for(;null!==i;)e(i,r,t),i=i.next,++r;return t}[Symbol.iterator](){return new _LinkerIterator.default(this.first)}}LinkedList.fromArray=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:_Linker.default;return(new(arguments.length>2&&void 0!==arguments[2]?arguments[2]:LinkedList)).initialize(t.fromArray(e).head)};var _default=exports.default=LinkedList;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0;var _Linker=_interopRequireDefault(require("./Linker")),_LinkerIterator=_interopRequireDefault(require("../../recipes/LinkerIterator")),_Arrayable=_interopRequireDefault(require("../arrayable/Arrayable"));function _interopRequireDefault(t){return t&&t.__esModule?t:{default:t}}class LinkedList{constructor(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:_Linker.default;this.classType=LinkedList,this.innerList=null,this.initialized=!1,this.linkerClass=t}initialize(t){return _Arrayable.default.prototype.initialize.call(this,t)}get list(){return this.innerList}get first(){return this.innerList}get last(){let t=this.innerList;if(null===t)return null;let e=t.next;for(;null!==e;)t=e,e=t.next;return t}get length(){let t=this.first,e=0;for(;null!==t;)++e,t=t.next;return e}insertAfter(t,e){return e=this.linkerClass.make(e),null!==t&&(e.next=t.next,t.next=e),this.length||(this.innerList=e),this}insertBefore(t,e){e=this.linkerClass.make(e);let r=null,i=this.first;for(;i!==t;)r=i,i=i.next;return e.next=t,r&&(r.next=e),t!==this.first&&null!==t||(this.innerList=e),this}append(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:this.last;return this.insertAfter(e,t)}prepend(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:this.first;return this.insertBefore(e,t)}remove(t){let e=null,r=this.first;for(;r!==t;)e=r,r=r.next;return e&&(e.next=t.next),t===this.first&&null!==t&&(this.innerList=t.next),t}item(t){if(t>=0){let e=this.first,r=-1;for(;++r<t&&null!==e;)e=e.next;return r===t?e:null}let e=this.first,r=0;const i=this.length+t;if(i<0)return null;for(;r<i&&null!==e;)e=e.next,++r;return r===i?e:null}forEach(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:this,r=0,i=e.first;for(;null!==i;)t(i,r,e),i=i.next,++r;return e}[Symbol.iterator](){return new _LinkerIterator.default(this.first)}}LinkedList.fromArray=function(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:_Linker.default;return new(arguments.length>2&&void 0!==arguments[2]?arguments[2]:LinkedList)(e).initialize(e.fromArray(t).head)};var _default=exports.default=LinkedList;

package/dist/collections/linked-list/Linker.d.ts

@@ -1,44 +1,44 @@
-/**
- * @file linked list item.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import IsLinker from '../../recipes/IsLinker';
-/**
- * Linker represents a node in a LinkedList.
- * @extends ArrayElement
- */
-declare class Linker implements IsLinker {
-    readonly classType: typeof Linker;
-    data: any;
-    next: Linker | null;
-    /**
-     * Create the new Linker instance, provide the data and optionally give the next Linker.
-     * @param {Object} [nodeData={}]
-     * @param {*} [nodeData.data=null] The data to be stored in this linker
-     * @param {Linker|null} [nodeData.next=null] The reference to the next linker if any
-     */
-    constructor({ data, next }?: {
-        data?: any;
-        next?: Linker | null;
-    });
-    /**
-     * Make a new Linker from the data given if it is not already a valid Linker.
-     * @param {Linker|*} linker Return a valid Linker instance from given data, or even an already valid one.
-     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
-     * @return {Linker}
-     */
-    static make: (linker: Linker | any, classType?: any) => IsLinker | any;
-    /**
-     * Convert an array into Linker instances, return the head and tail Linkers.
-     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of linkers.
-     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
-     * @returns {{head: Linker, tail: Linker}}
-     */
-    static fromArray: (values: Array<any>, classType?: any) => {
-        head: IsLinker;
-        tail: IsLinker;
-    };
-}
-export default Linker;
+/**
+ * @file linked list item.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.1.0
+ * @memberOf module:collect-your-stuff
+ */
+import IsLinker from '../../recipes/IsLinker';
+/**
+ * Linker represents a node in a LinkedList.
+ * @extends ArrayElement
+ */
+declare class Linker implements IsLinker {
+    readonly classType: typeof Linker;
+    data: any;
+    next: Linker | null;
+    /**
+     * Create the new Linker instance, provide the data and optionally give the next Linker.
+     * @param {Object} [nodeData={}]
+     * @param {*} [nodeData.data=null] The data to be stored in this linker
+     * @param {Linker|null} [nodeData.next=null] The reference to the next linker if any
+     */
+    constructor({ data, next }?: {
+        data?: any;
+        next?: Linker | null;
+    });
+    /**
+     * Make a new Linker from the data given if it is not already a valid Linker.
+     * @param {Linker|*} linker Return a valid Linker instance from given data, or even an already valid one.
+     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
+     * @return {Linker}
+     */
+    static make: (linker: Linker | any, classType?: any) => IsLinker | any;
+    /**
+     * Convert an array into Linker instances, return the head and tail Linkers.
+     * @param {Array} [values=[]] Provide an array of data that will be converted to a chain of linkers.
+     * @param {IsLinker} [classType=Linker] Provide the type of IsLinker to use.
+     * @returns {{head: Linker, tail: Linker}}
+     */
+    static fromArray: (values: Array<any>, classType?: any) => {
+        head: IsLinker;
+        tail: IsLinker;
+    };
+}
+export default Linker;