collect-your-stuff 1.3.0 → 1.4.0

package/dist/collections/arrayable/ArrayElement.d.ts

@@ -9,7 +9,9 @@ import { IsElement } from '../../recipes/IsElement';
  * Element represents a node in an Arrayable.
  */
 export declare class ArrayElement implements IsElement {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
     readonly classType: typeof ArrayElement;
+    /** The data stored in this element. */
     data: any;
     /**
      * Create the new Element instance, provide the data and optionally configure the type of Element.

package/dist/collections/arrayable/ArrayElement.js

@@ -15,7 +15,9 @@ class ArrayElement {
    * @param {*} [data=null] The data to be stored in this element.
    */
   constructor (data = null) {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
     this.classType = ArrayElement
+    /** The data stored in this element. */
     this.data = null
     this.data = data
   }
@@ -28,8 +30,8 @@ class ArrayElement {
  */
 exports.ArrayElement = ArrayElement
 ArrayElement.make = (element, classType = ArrayElement) => {
-  if (typeof element !== 'object') {
-    // It is not an object, so instantiate the Element with element as the data
+  if (element === null || typeof element !== 'object') {
+    // It is not an object (or it is null), so instantiate the Element with element as the data
     return new classType(element)
   }
   if (element.classType) {

package/dist/collections/arrayable/ArrayElement.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ArrayElement=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.reduce.js");class ArrayElement{constructor(e=null){this.classType=ArrayElement,this.data=null,this.data=e}}exports.ArrayElement=ArrayElement,ArrayElement.make=(e,r=ArrayElement)=>"object"!=typeof e?new r(e):e.classType?e:new r(e),ArrayElement.fromArray=(e=[],r=ArrayElement)=>e.reduce(((e,t)=>{const a=r.make(t,r);return e.head.length?(e.head.push(a),e.tail=a,e):{head:[a],tail:a}}),{head:[],tail:null});
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ArrayElement=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.reduce.js");class ArrayElement{constructor(e=null){this.classType=ArrayElement,this.data=null,this.data=e}}exports.ArrayElement=ArrayElement,ArrayElement.make=(e,r=ArrayElement)=>null===e||"object"!=typeof e?new r(e):e.classType?e:new r(e),ArrayElement.fromArray=(e=[],r=ArrayElement)=>e.reduce(((e,t)=>{const a=r.make(t,r);return e.head.length?(e.head.push(a),e.tail=a,e):{head:[a],tail:a}}),{head:[],tail:null});

package/dist/collections/arrayable/Arrayable.d.ts

@@ -11,14 +11,26 @@ import { IsElement } from '../../recipes/IsElement';
  * Arrayable represents a collection stored as an array.
  */
 export declare class Arrayable implements IsArrayable<ArrayElement>, Iterable<ArrayElement> {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
     readonly classType: typeof Arrayable;
+    /** The array which stores the elements of this Arrayable. */
     innerList: Array<ArrayElement>;
+    /** Whether the inner list has been initialized (it can only be initialized once). */
     initialized: boolean;
+    /** The class used to wrap the data given to this Arrayable as elements. */
     elementClass: typeof ArrayElement;
     /**
      * Create the new Arrayable instance, configure the Arrayable class.
+     * @param {ArrayElement} [elementClass=ArrayElement] The class used to wrap given data as elements.
      */
     constructor(elementClass?: typeof ArrayElement);
+    /**
+     * Find the position of an element which must be in this list.
+     * @param {ArrayElement} node The element to find
+     * @returns {number}
+     * @throws {Error} When the element is not in this list
+     */
+    private indexOfElement;
     /**
      * Initialize the inner list, should only run once.
      * @param {Array<ArrayElement>} initialList Give the array of elements to start in this Arrayable.
@@ -26,20 +38,20 @@ export declare class Arrayable implements IsArrayable<ArrayElement>, Iterable<Ar
      */
     initialize(initialList: Array<ArrayElement>): Arrayable;
     /**
-     * Retrieve a copy of the innerList used.
+     * Retrieve the innerList used (the list itself, not a copy).
      * @returns {Array<ArrayElement>}
      */
     get list(): Array<ArrayElement>;
     /**
      * Retrieve the first Element from the Arrayable
-     * @returns {ArrayElement}
+     * @returns {ArrayElement|null} The first element, or null when the Arrayable is empty
      */
-    get first(): ArrayElement;
+    get first(): ArrayElement | null;
     /**
      * Retrieve the last Element from the Arrayable
-     * @returns {ArrayElement}
+     * @returns {ArrayElement|null} The last element, or null when the Arrayable is empty
      */
-    get last(): ArrayElement;
+    get last(): ArrayElement | null;
     /**
      * Return the length of the list.
      * @returns {number}
@@ -47,38 +59,40 @@ export declare class Arrayable implements IsArrayable<ArrayElement>, Iterable<Ar
     get length(): number;
     /**
      * Insert a new node (or data) after a node.
-     * @param {ArrayElement|*} node The existing node as reference
+     * @param {ArrayElement|null} node The existing node as reference, or null to insert at the start of the list
      * @param {ArrayElement|*} newNode The new node to go after the existing node
      * @returns {Arrayable}
+     * @throws {Error} When the reference node is not in this list
      */
-    insertAfter(node: ArrayElement, newNode: ArrayElement | any): Arrayable;
+    insertAfter(node: ArrayElement | null, newNode: ArrayElement | any): Arrayable;
     /**
      * Insert a new node (or data) before a node.
-     * @param {ArrayElement|*} node The existing node as reference
+     * @param {ArrayElement|null} node The existing node as reference, or null to insert at the end of the list
      * @param {ArrayElement|*} newNode The new node to go before the existing node
      * @returns {Arrayable}
+     * @throws {Error} When the reference node is not in this list
      */
-    insertBefore(node: ArrayElement, newNode: ArrayElement | any): Arrayable;
+    insertBefore(node: ArrayElement | null, newNode: ArrayElement | any): Arrayable;
     /**
      * Add a node (or data) after the given (or last) node in the list.
      * @param {ArrayElement|*} node The new node to add to the end of the list
      * @param {ArrayElement} after The existing last node
      * @returns {Arrayable}
      */
-    append(node: ArrayElement | any, after?: ArrayElement): Arrayable;
+    append(node: ArrayElement | any, after?: ArrayElement | null): Arrayable;
     /**
      * Add a node (or data) before the given (or first) node in the list.
      * @param {ArrayElement|*} node The new node to add to the start of the list
      * @param {ArrayElement} before The existing first node
      * @returns {Arrayable}
      */
-    prepend(node: ArrayElement | any, before?: ArrayElement): Arrayable;
+    prepend(node: ArrayElement | any, before?: ArrayElement | null): Arrayable;
     /**
      * Remove an element from this arrayable.
      * @param {ArrayElement} node The node we wish to remove (and it will be returned after removal)
-     * @return {ArrayElement}
+     * @return {ArrayElement|null} The removed node, or null when it was not in this list (nothing is removed)
      */
-    remove(node: ArrayElement): ArrayElement;
+    remove(node: ArrayElement): ArrayElement | null;
     /**
      * Retrieve an ArrayElement item from this list by numeric index, otherwise return null.
      * @param {number} index The integer number for retrieving a node by position.

package/dist/collections/arrayable/Arrayable.js

@@ -19,14 +19,32 @@ var _ArrayIterator = require('../../recipes/ArrayIterator')
 class Arrayable {
   /**
    * Create the new Arrayable instance, configure the Arrayable class.
+   * @param {ArrayElement} [elementClass=ArrayElement] The class used to wrap given data as elements.
    */
   constructor (elementClass = _ArrayElement.ArrayElement) {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
     this.classType = Arrayable
+    /** The array which stores the elements of this Arrayable. */
     this.innerList = []
+    /** Whether the inner list has been initialized (it can only be initialized once). */
     this.initialized = false
     this.elementClass = elementClass
   }
 
+  /**
+   * Find the position of an element which must be in this list.
+   * @param {ArrayElement} node The element to find
+   * @returns {number}
+   * @throws {Error} When the element is not in this list
+   */
+  indexOfElement (node) {
+    const index = this.innerList.indexOf(node)
+    if (index < 0) {
+      throw new Error('The reference element is not in this list.')
+    }
+    return index
+  }
+
   /**
    * Initialize the inner list, should only run once.
    * @param {Array<ArrayElement>} initialList Give the array of elements to start in this Arrayable.
@@ -43,7 +61,7 @@ class Arrayable {
   }
 
   /**
-   * Retrieve a copy of the innerList used.
+   * Retrieve the innerList used (the list itself, not a copy).
    * @returns {Array<ArrayElement>}
    */
   get list () {
@@ -52,18 +70,18 @@ class Arrayable {
 
   /**
    * Retrieve the first Element from the Arrayable
-   * @returns {ArrayElement}
+   * @returns {ArrayElement|null} The first element, or null when the Arrayable is empty
    */
   get first () {
-    return this.innerList[0]
+    return this.length ? this.innerList[0] : null
   }
 
   /**
    * Retrieve the last Element from the Arrayable
-   * @returns {ArrayElement}
+   * @returns {ArrayElement|null} The last element, or null when the Arrayable is empty
    */
   get last () {
-    return this.innerList[this.length - 1]
+    return this.length ? this.innerList[this.length - 1] : null
   }
 
   /**
@@ -76,25 +94,29 @@ class Arrayable {
 
   /**
    * Insert a new node (or data) after a node.
-   * @param {ArrayElement|*} node The existing node as reference
+   * @param {ArrayElement|null} node The existing node as reference, or null to insert at the start of the list
    * @param {ArrayElement|*} newNode The new node to go after the existing node
    * @returns {Arrayable}
+   * @throws {Error} When the reference node is not in this list
    */
   insertAfter (node, newNode) {
-    const insertAt = this.innerList.indexOf(node)
-    this.innerList.splice(insertAt + 1, 0, this.elementClass.make(newNode))
+    // With no reference element, the new one goes after nothing: at the start of the list
+    const insertAt = node === null || typeof node === 'undefined' ? -1 : this.indexOfElement(node)
+    this.innerList.splice(insertAt + 1, 0, this.elementClass.make(newNode, this.elementClass))
     return this
   }
 
   /**
    * Insert a new node (or data) before a node.
-   * @param {ArrayElement|*} node The existing node as reference
+   * @param {ArrayElement|null} node The existing node as reference, or null to insert at the end of the list
    * @param {ArrayElement|*} newNode The new node to go before the existing node
    * @returns {Arrayable}
+   * @throws {Error} When the reference node is not in this list
    */
   insertBefore (node, newNode) {
-    const insertAt = this.innerList.indexOf(node)
-    this.innerList.splice(insertAt, 0, this.elementClass.make(newNode))
+    // With no reference element, the new one goes before nothing: at the end of the list
+    const insertAt = node === null || typeof node === 'undefined' ? this.length : this.indexOfElement(node)
+    this.innerList.splice(insertAt, 0, this.elementClass.make(newNode, this.elementClass))
     return this
   }
 
@@ -105,6 +127,11 @@ class Arrayable {
    * @returns {Arrayable}
    */
   append (node, after = this.last) {
+    if (after === this.last) {
+      // Adding to the end does not need to search for where that is
+      this.innerList.push(this.elementClass.make(node, this.elementClass))
+      return this
+    }
     return this.insertAfter(after, node)
   }
 
@@ -115,16 +142,24 @@ class Arrayable {
    * @returns {Arrayable}
    */
   prepend (node, before = this.first) {
+    if (before === this.first) {
+      // Adding to the start does not need to search for where that is
+      this.innerList.unshift(this.elementClass.make(node, this.elementClass))
+      return this
+    }
     return this.insertBefore(before, node)
   }
 
   /**
    * Remove an element from this arrayable.
    * @param {ArrayElement} node The node we wish to remove (and it will be returned after removal)
-   * @return {ArrayElement}
+   * @return {ArrayElement|null} The removed node, or null when it was not in this list (nothing is removed)
    */
   remove (node) {
     const deleteAt = this.innerList.indexOf(node)
+    if (deleteAt < 0) {
+      return null
+    }
     this.innerList.splice(deleteAt, 1)
     return node
   }

package/dist/collections/arrayable/Arrayable.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Arrayable=void 0;var _ArrayElement=require("./ArrayElement"),_ArrayIterator=require("../../recipes/ArrayIterator");class Arrayable{constructor(t=_ArrayElement.ArrayElement){this.classType=Arrayable,this.innerList=[],this.initialized=!1,this.elementClass=t}initialize(t){return this.initialized?(console.warn("Attempt to initialize non-empty list."),this):(this.initialized=!0,this.innerList=t,this)}get list(){return this.innerList}get first(){return this.innerList[0]}get last(){return this.innerList[this.length-1]}get length(){return this.innerList.length}insertAfter(t,e){const r=this.innerList.indexOf(t);return this.innerList.splice(r+1,0,this.elementClass.make(e)),this}insertBefore(t,e){const r=this.innerList.indexOf(t);return this.innerList.splice(r,0,this.elementClass.make(e)),this}append(t,e=this.last){return this.insertAfter(e,t)}prepend(t,e=this.first){return this.insertBefore(e,t)}remove(t){const e=this.innerList.indexOf(t);return this.innerList.splice(e,1),t}item(t){if(t>=this.length)return null;if(t>=0)return this.innerList[t];const e=this.length+t;return e<0?null:this.innerList[e]}forEach(t,e=this){for(let r=0;r<e.length;++r)t(e.item(r),r,e);return e}[Symbol.iterator](){return new _ArrayIterator.ArrayIterator(this.innerList,0)}}exports.Arrayable=Arrayable,Arrayable.fromArray=(t=[],e=_ArrayElement.ArrayElement,r=Arrayable)=>new r(e).initialize(e.fromArray(t).head);
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Arrayable=void 0;var _ArrayElement=require("./ArrayElement"),_ArrayIterator=require("../../recipes/ArrayIterator");class Arrayable{constructor(e=_ArrayElement.ArrayElement){this.classType=Arrayable,this.innerList=[],this.initialized=!1,this.elementClass=e}indexOfElement(e){const t=this.innerList.indexOf(e);if(t<0)throw new Error("The reference element is not in this list.");return t}initialize(e){return this.initialized?(console.warn("Attempt to initialize non-empty list."),this):(this.initialized=!0,this.innerList=e,this)}get list(){return this.innerList}get first(){return this.length?this.innerList[0]:null}get last(){return this.length?this.innerList[this.length-1]:null}get length(){return this.innerList.length}insertAfter(e,t){const i=null==e?-1:this.indexOfElement(e);return this.innerList.splice(i+1,0,this.elementClass.make(t,this.elementClass)),this}insertBefore(e,t){const i=null==e?this.length:this.indexOfElement(e);return this.innerList.splice(i,0,this.elementClass.make(t,this.elementClass)),this}append(e,t=this.last){return t===this.last?(this.innerList.push(this.elementClass.make(e,this.elementClass)),this):this.insertAfter(t,e)}prepend(e,t=this.first){return t===this.first?(this.innerList.unshift(this.elementClass.make(e,this.elementClass)),this):this.insertBefore(t,e)}remove(e){const t=this.innerList.indexOf(e);return t<0?null:(this.innerList.splice(t,1),e)}item(e){if(e>=this.length)return null;if(e>=0)return this.innerList[e];const t=this.length+e;return t<0?null:this.innerList[t]}forEach(e,t=this){for(let i=0;i<t.length;++i)e(t.item(i),i,t);return t}[Symbol.iterator](){return new _ArrayIterator.ArrayIterator(this.innerList,0)}}exports.Arrayable=Arrayable,Arrayable.fromArray=(e=[],t=_ArrayElement.ArrayElement,i=Arrayable)=>new i(t).initialize(t.fromArray(e).head);

package/dist/collections/doubly-linked-list/DoubleLinker.d.ts

@@ -10,13 +10,17 @@ import { IsDoubleLinker } from '../../recipes/IsDoubleLinker';
  * @extends Linker
  */
 export declare class DoubleLinker implements IsDoubleLinker {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
     readonly classType: typeof DoubleLinker;
+    /** The data stored in this linker. */
     data: any;
+    /** The linker after this one, or null when this is the last. */
     next: DoubleLinker | null;
+    /** The linker before this one, or null when this is the first. */
     prev: DoubleLinker | null;
     /**
      * Create the new DoubleLinker instance, provide the data and optionally the next and prev references.
-     * @param {Object} [nodeData={}]
+     * @param {Object} [nodeData={}] The settings for the new linker.
      * @param {*} [nodeData.data=null] The data to be stored in this linker
      * @param {DoubleLinker|null} [nodeData.next=null] The reference to the next linker if any
      * @param {DoubleLinker|null} [nodeData.prev=null] The reference to the previous linker if any

package/dist/collections/doubly-linked-list/DoubleLinker.js

@@ -14,7 +14,7 @@ var _Linker = require('../linked-list/Linker')
 class DoubleLinker {
   /**
    * Create the new DoubleLinker instance, provide the data and optionally the next and prev references.
-   * @param {Object} [nodeData={}]
+   * @param {Object} [nodeData={}] The settings for the new linker.
    * @param {*} [nodeData.data=null] The data to be stored in this linker
    * @param {DoubleLinker|null} [nodeData.next=null] The reference to the next linker if any
    * @param {DoubleLinker|null} [nodeData.prev=null] The reference to the previous linker if any
@@ -24,9 +24,13 @@ class DoubleLinker {
     next = null,
     prev = null
   } = {}) {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
     this.classType = DoubleLinker
+    /** The data stored in this linker. */
     this.data = null
+    /** The linker after this one, or null when this is the last. */
     this.next = null
+    /** The linker before this one, or null when this is the first. */
     this.prev = null
     this.data = data
     this.next = next

package/dist/collections/doubly-linked-list/DoublyLinkedList.d.ts

@@ -12,12 +12,21 @@ import { IsDoubleLinker } from '../../recipes/IsDoubleLinker';
  * @extends LinkedList
  */
 export declare class DoublyLinkedList implements IsArrayable<DoubleLinker>, Iterable<DoubleLinker> {
+    /** The class used to create this instance, so that it can be recognized as valid without an instanceof check. */
     readonly classType: typeof DoublyLinkedList;
+    /** A linker of the list (null when the list is empty); the head is found by walking back from it. */
     innerList: DoubleLinker;
+    /** Whether the inner list has been initialized (it can only be initialized once). */
     initialized: boolean;
+    /** The class used to wrap the data given to this list as linkers. */
     linkerClass: typeof DoubleLinker;
+    /** The last linker, remembered so that adding to the end does not need to walk the whole list (null when not known yet). */
+    private tailCache;
+    /** The number of linkers, kept up to date by the list's own methods so that the length does not need to walk the whole list (null when not known yet). */
+    private countCache;
     /**
      * Create the new DoublyLinkedList instance.
+     * @param {DoubleLinker} [linkerClass=DoubleLinker] The class used to wrap given data as linkers.
      */
     constructor(linkerClass?: typeof DoubleLinker);
     /**
@@ -27,7 +36,7 @@ export declare class DoublyLinkedList implements IsArrayable<DoubleLinker>, Iter
      */
     initialize(initialList: DoubleLinker): DoublyLinkedList;
     /**
-     * Retrieve a copy of the innerList used.
+     * Retrieve the innerList used (the list itself, not a copy).
      * @returns {DoubleLinker}
      */
     get list(): DoubleLinker;
@@ -35,31 +44,32 @@ export declare class DoublyLinkedList implements IsArrayable<DoubleLinker>, Iter
      * Retrieve the first DoubleLinker in the list.
      * @returns {DoubleLinker}
      */
-    get first(): DoubleLinker;
+    get first(): DoubleLinker | null;
     /**
-     * Retrieve the last DoubleLinker in the list.
+     * Retrieve the last DoubleLinker in the list. The end is remembered, so this does not walk the list.
      * @returns {DoubleLinker}
      */
-    get last(): DoubleLinker;
+    get last(): DoubleLinker | null;
     /**
-     * Return the length of the list.
+     * Return the length of the list. It is kept up to date by the list's own methods, so this does not walk the list
+     * (call reset() after linkers were changed directly).
      * @returns {number}
      */
     get length(): number;
     /**
      * Insert a new node (or data) after a node.
-     * @param {DoubleLinker|*} node The existing node as reference
+     * @param {DoubleLinker|*} node The existing node as reference (which must be in this list, this is not checked), or null to insert at the start of the list
      * @param {DoubleLinker|*} newNode The new node to go after the existing node
      * @returns {DoublyLinkedList}
      */
-    insertAfter(node: DoubleLinker, newNode: DoubleLinker | any): DoublyLinkedList;
+    insertAfter(node: DoubleLinker | null, newNode: DoubleLinker | any): DoublyLinkedList;
     /**
      * Insert a new node (or data) before a node.
-     * @param {DoubleLinker|*} node The existing node as reference
+     * @param {DoubleLinker|*} node The existing node as reference (which must be in this list, this is not checked), or null to insert at the end of the list
      * @param {DoubleLinker|*} newNode The new node to go before the existing node
      * @returns {DoublyLinkedList}
      */
-    insertBefore(node: DoubleLinker, newNode: DoubleLinker | any): DoublyLinkedList;
+    insertBefore(node: DoubleLinker | null, newNode: DoubleLinker | any): DoublyLinkedList;
     /**
      * Add a node (or data) after the given (or last) node in the list.
      * @param {DoubleLinker|*} node The new node to add to the end of the list
@@ -79,12 +89,13 @@ export declare class DoublyLinkedList implements IsArrayable<DoubleLinker>, Iter
      * @param {DoubleLinker} node The node we wish to remove (and it will be returned after removal)
      * @return {DoubleLinker}
      */
-    remove(node: DoubleLinker): DoubleLinker;
+    remove(node: DoubleLinker | null): DoubleLinker | null;
     /**
-     * Refresh all references and return head reference.
-     * @return {DoubleLinker}
+     * Refresh all references (the head, the end and the length) by walking the list once, and return the head. The list's
+     * own methods keep these up to date, so this is only needed after linkers were changed directly.
+     * @return {DoubleLinker|null}
      */
-    reset(): DoubleLinker;
+    reset(): DoubleLinker | null;
     /**
      * Retrieve a DoubleLinker item from this list by numeric index, otherwise return null.
      * @param {number} index The integer number for retrieving a node by position.
@@ -95,6 +106,7 @@ export declare class DoublyLinkedList implements IsArrayable<DoubleLinker>, Iter
      * Be able to run forEach on this DoublyLinkedList to iterate over the DoubleLinker Items.
      * @param {forEachCallback} callback The function to call for-each double linker
      * @param {DoublyLinkedList} thisArg Optional, 'this' reference
+     * @return {DoublyLinkedList} The list which was iterated.
      */
     forEach(callback: forEachCallback, thisArg?: DoublyLinkedList): DoublyLinkedList;
     /**