collect-your-stuff 2.1.1 → 2.2.0

package/dist/collections/arrayable/ArrayElement.js

@@ -1,66 +1,64 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.ArrayElement = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.reduce.js')
-/**
- * Element represents a node in an Arrayable.
- */
-class ArrayElement {
-  /**
-   * Create the new Element instance, provide the data and optionally configure the type of Element.
-   * @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
-  }
-}
-/**
- * Make a new Element from the data given if it is not already a valid Element.
- * @param {ArrayElement|*} element Return a valid ArrayElement instance from given data, or even an already valid one.
- * @param {IsElement} [classType=ArrayElement] Provide the type of IsElement to use.
- * @return {ArrayElement}
- */
-exports.ArrayElement = ArrayElement
-ArrayElement.make = (element, classType = ArrayElement) => {
-  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) {
-    // Already valid Element, return as-is
-    return element
-  }
-  // Create the new node as the configured #classType
-  return new classType(element)
-}
-/**
- * Convert an array into Element instances, return the head and tail Elements.
- * @param {Array<IsElement>} [values=[]] Provide an array of data that will be converted to array of elements.
- * @param {IsElement} [classType=ArrayElement] Provide the type of IsElement to use.
- * @returns {{head: ArrayElement[], tail: ArrayElement}}
- */
-ArrayElement.fromArray = (values = [], classType = ArrayElement) => values.reduce((references, element) => {
-  const newElement = classType.make(element, classType)
-  if (!references.head.length) {
-    // Initialize the head and tail with the new node
-    return {
-      head: [newElement],
-      tail: newElement
-    }
-  }
-  // Only update the tail once head has been set, tail is always the most recent node
-  references.head.push(newElement)
-  references.tail = newElement
-  return references
-}, {
-  head: [],
-  tail: null
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.ArrayElement = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.reduce.js')
+/**
+ * Element represents a node in an Arrayable.
+ */
+class ArrayElement {
+  /**
+   * Create the new Element instance, provide the data and optionally configure the type of Element.
+   * @param data 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
+  }
+}
+/**
+ * Make a new Element from the data given if it is not already a valid Element.
+ * @param element Return a valid ArrayElement instance from given data, or even an already valid one.
+ * @param classType Provide the type of IsElement to use.
+ */
+exports.ArrayElement = ArrayElement
+ArrayElement.make = (element, classType = ArrayElement) => {
+  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) {
+    // Already valid Element, return as-is
+    return element
+  }
+  // Create the new node as the configured #classType
+  return new classType(element)
+}
+/**
+ * Convert an array into Element instances, return the head and tail Elements.
+ * @param values Provide an array of data that will be converted to array of elements.
+ * @param classType Provide the type of IsElement to use.
+ */
+ArrayElement.fromArray = (values = [], classType = ArrayElement) => values.reduce((references, element) => {
+  const newElement = classType.make(element, classType)
+  if (!references.head.length) {
+    // Initialize the head and tail with the new node
+    return {
+      head: [newElement],
+      tail: newElement
+    }
+  }
+  // Only update the tail once head has been set, tail is always the most recent node
+  references.head.push(newElement)
+  references.tail = newElement
+  return references
+}, {
+  head: [],
+  tail: null
+})

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

@@ -1,122 +1,107 @@
-/**
- * @file arrayable list.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.1.0
- * @memberOf module:collect-your-stuff
- */
-import { ArrayElement } from './ArrayElement';
-import { forEachCallback, IsArrayable } from '../../recipes/IsArrayable';
-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.
-     * @return {Arrayable}
-     */
-    initialize(initialList: Array<ArrayElement>): Arrayable;
-    /**
-     * 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|null} The first element, or null when the Arrayable is empty
-     */
-    get first(): ArrayElement | null;
-    /**
-     * Retrieve the last Element from the Arrayable
-     * @returns {ArrayElement|null} The last element, or null when the Arrayable is empty
-     */
-    get last(): ArrayElement | null;
-    /**
-     * Return the length of the list.
-     * @returns {number}
-     */
-    get length(): number;
-    /**
-     * Insert a new node (or data) after a node.
-     * @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 | null, newNode: ArrayElement | any): Arrayable;
-    /**
-     * Insert a new node (or data) before a node.
-     * @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 | 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 | 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 | 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|null} The removed node, or null when it was not in this list (nothing is removed)
-     */
-    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.
-     * @return {ArrayElement|null}
-     */
-    item(index: number): ArrayElement | null;
-    /**
-     * Be able to run forEach on this Arrayable to iterate over the elements.
-     * @param {forEachCallback} callback The function to call for-each element
-     * @param {Arrayable} thisArg Optional, 'this' reference
-     * @returns {Arrayable}
-     */
-    forEach(callback: forEachCallback, thisArg?: Arrayable): Arrayable;
-    /**
-     * Be able to iterate over this class.
-     * @returns {Iterator}
-     */
-    [Symbol.iterator](): Iterator<ArrayElement>;
-    /**
-     * Convert an array to an Arrayable.
-     * @param {Array} values An array of values which will be converted to elements in this arrayable
-     * @param {IsElement} [elementClass=ArrayElement] The class to use for each element
-     * @param {IsArrayable<ArrayElement>} [classType=Arrayable] Provide the type of IsArrayable to use.
-     * @returns {Arrayable}
-     */
-    static fromArray: (values?: Array<any>, elementClass?: typeof ArrayElement, classType?: any) => IsArrayable<IsElement>;
-}
+/**
+ * arrayable list.
+ */
+import { ArrayElement } from './ArrayElement';
+import { forEachCallback, IsArrayable } from '../../recipes/IsArrayable';
+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 elementClass 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 node The element to find
+     * @throws {Error} When the element is not in this list
+     */
+    private indexOfElement;
+    /**
+     * Initialize the inner list, should only run once.
+     * @param initialList Give the array of elements to start in this Arrayable.
+     */
+    initialize(initialList: Array<ArrayElement>): Arrayable;
+    /**
+     * Retrieve the innerList used (the list itself, not a copy).
+     */
+    get list(): Array<ArrayElement>;
+    /**
+     * Retrieve the first Element from the Arrayable
+     * @returns The first element, or null when the Arrayable is empty
+     */
+    get first(): ArrayElement | null;
+    /**
+     * Retrieve the last Element from the Arrayable
+     * @returns The last element, or null when the Arrayable is empty
+     */
+    get last(): ArrayElement | null;
+    /**
+     * Return the length of the list.
+     */
+    get length(): number;
+    /**
+     * Insert a new node (or data) after a node.
+     * @param node The existing node as reference, or null to insert at the start of the list
+     * @param newNode The new node to go after the existing node
+     * @throws {Error} When the reference node is not in this list
+     */
+    insertAfter(node: ArrayElement | null, newNode: ArrayElement | any): Arrayable;
+    /**
+     * Insert a new node (or data) before a node.
+     * @param node The existing node as reference, or null to insert at the end of the list
+     * @param newNode The new node to go before the existing node
+     * @throws {Error} When the reference node is not in this list
+     */
+    insertBefore(node: ArrayElement | null, newNode: ArrayElement | any): Arrayable;
+    /**
+     * Add a node (or data) after the given (or last) node in the list.
+     * @param node The new node to add to the end of the list
+     * @param after The existing last node
+     */
+    append(node: ArrayElement | any, after?: ArrayElement | null): Arrayable;
+    /**
+     * Add a node (or data) before the given (or first) node in the list.
+     * @param node The new node to add to the start of the list
+     * @param before The existing first node
+     */
+    prepend(node: ArrayElement | any, before?: ArrayElement | null): Arrayable;
+    /**
+     * Remove an element from this arrayable.
+     * @param node The node we wish to remove (and it will be returned after removal)
+     * @returns The removed node, or null when it was not in this list (nothing is removed)
+     */
+    remove(node: ArrayElement): ArrayElement | null;
+    /**
+     * Retrieve an ArrayElement item from this list by numeric index, otherwise return null.
+     * @param index The integer number for retrieving a node by position.
+     */
+    item(index: number): ArrayElement | null;
+    /**
+     * Be able to run forEach on this Arrayable to iterate over the elements.
+     * @param callback The function to call for-each element
+     * @param thisArg Optional, 'this' reference
+     */
+    forEach(callback: forEachCallback, thisArg?: Arrayable): Arrayable;
+    /**
+     * Be able to iterate over this class.
+     */
+    [Symbol.iterator](): Iterator<ArrayElement>;
+    /**
+     * Convert an array to an Arrayable.
+     * @param values An array of values which will be converted to elements in this arrayable
+     * @param elementClass The class to use for each element
+     * @param classType Provide the type of IsArrayable to use.
+     */
+    static fromArray: (values?: Array<any>, elementClass?: typeof ArrayElement, classType?: any) => IsArrayable<IsElement>;
+}