data-structure-typed 1.52.4 → 1.52.5

package/dist/cjs/utils/utils.js

@@ -11,6 +11,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.roundFixed = exports.calcMinUnitsRequired = exports.isWeakKey = exports.throwRangeError = exports.rangeCheck = exports.getMSB = exports.trampolineAsync = exports.trampoline = exports.toThunk = exports.isThunk = exports.THUNK_SYMBOL = exports.arrayRemove = exports.uuidV4 = void 0;
 exports.isComparable = isComparable;
+/**
+ * The function generates a random UUID (Universally Unique Identifier) in TypeScript.
+ * @returns A randomly generated UUID (Universally Unique Identifier) in the format
+ * 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' where each 'x' is replaced with a random hexadecimal
+ * character.
+ */
 const uuidV4 = function () {
     return 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'.replace(/[x]/g, function (c) {
         const r = (Math.random() * 16) | 0, v = c == 'x' ? r : (r & 0x3) | 0x8;
@@ -18,6 +24,15 @@ const uuidV4 = function () {
     });
 };
 exports.uuidV4 = uuidV4;
+/**
+ * The `arrayRemove` function removes elements from an array based on a specified predicate function
+ * and returns the removed elements.
+ * @param {T[]} array - An array of elements that you want to filter based on the provided predicate
+ * function.
+ * @param predicate - The `predicate` parameter is a function that takes three arguments:
+ * @returns The `arrayRemove` function returns an array containing the elements that satisfy the given
+ * `predicate` function.
+ */
 const arrayRemove = function (array, predicate) {
     let i = -1, len = array ? array.length : 0;
     const result = [];
@@ -33,16 +48,43 @@ const arrayRemove = function (array, predicate) {
 };
 exports.arrayRemove = arrayRemove;
 exports.THUNK_SYMBOL = Symbol('thunk');
+/**
+ * The function `isThunk` checks if a given value is a function with a specific symbol property.
+ * @param {any} fnOrValue - The `fnOrValue` parameter in the `isThunk` function can be either a
+ * function or a value that you want to check if it is a thunk. Thunks are functions that are wrapped
+ * around a value or computation for lazy evaluation. The function checks if the `fnOrValue` is
+ * @returns The function `isThunk` is checking if the input `fnOrValue` is a function and if it has a
+ * property `__THUNK__` equal to `THUNK_SYMBOL`. The return value will be `true` if both conditions are
+ * met, otherwise it will be `false`.
+ */
 const isThunk = (fnOrValue) => {
     return typeof fnOrValue === 'function' && fnOrValue.__THUNK__ === exports.THUNK_SYMBOL;
 };
 exports.isThunk = isThunk;
+/**
+ * The `toThunk` function in TypeScript converts a function into a thunk by wrapping it in a closure.
+ * @param {ToThunkFn} fn - `fn` is a function that will be converted into a thunk.
+ * @returns A thunk function is being returned. Thunk functions are functions that delay the evaluation
+ * of an expression or operation until it is explicitly called or invoked. In this case, the `toThunk`
+ * function takes a function `fn` as an argument and returns a thunk function that, when called, will
+ * execute the `fn` function provided as an argument.
+ */
 const toThunk = (fn) => {
     const thunk = () => fn();
     thunk.__THUNK__ = exports.THUNK_SYMBOL;
     return thunk;
 };
 exports.toThunk = toThunk;
+/**
+ * The `trampoline` function in TypeScript enables tail call optimization by using thunks to avoid
+ * stack overflow.
+ * @param {TrlFn} fn - The `fn` parameter in the `trampoline` function is a function that takes any
+ * number of arguments and returns a value.
+ * @returns The `trampoline` function returns an object with two properties:
+ * 1. A function that executes the provided function `fn` and continues to execute any thunks returned
+ * by `fn` until a non-thunk value is returned.
+ * 2. A `cont` property that is a function which creates a thunk for the provided function `fn`.
+ */
 const trampoline = (fn) => {
     const cont = (...args) => (0, exports.toThunk)(() => fn(...args));
     return Object.assign((...args) => {
@@ -54,6 +96,18 @@ const trampoline = (fn) => {
     }, { cont });
 };
 exports.trampoline = trampoline;
+/**
+ * The `trampolineAsync` function in TypeScript allows for asynchronous trampolining of a given
+ * function.
+ * @param {TrlAsyncFn} fn - The `fn` parameter in the `trampolineAsync` function is expected to be a
+ * function that returns a Promise. This function will be called recursively until a non-thunk value is
+ * returned.
+ * @returns The `trampolineAsync` function returns an object with two properties:
+ * 1. An async function that executes the provided `TrlAsyncFn` function and continues to execute any
+ * thunks returned by the function until a non-thunk value is returned.
+ * 2. A `cont` property that is a function which wraps the provided `TrlAsyncFn` function in a thunk
+ * and returns it.
+ */
 const trampolineAsync = (fn) => {
     const cont = (...args) => (0, exports.toThunk)(() => fn(...args));
     return Object.assign((...args) => __awaiter(void 0, void 0, void 0, function* () {
@@ -65,6 +119,15 @@ const trampolineAsync = (fn) => {
     }), { cont });
 };
 exports.trampolineAsync = trampolineAsync;
+/**
+ * The function `getMSB` returns the most significant bit of a given number.
+ * @param {number} value - The `value` parameter is a number for which we want to find the position of
+ * the Most Significant Bit (MSB). The function `getMSB` takes this number as input and calculates the
+ * position of the MSB in its binary representation.
+ * @returns The function `getMSB` returns the most significant bit (MSB) of the input `value`. If the
+ * input value is less than or equal to 0, it returns 0. Otherwise, it calculates the position of the
+ * MSB using the `Math.clz32` function and bitwise left shifts 1 to that position.
+ */
 const getMSB = (value) => {
     if (value <= 0) {
         return 0;
@@ -72,50 +135,143 @@ const getMSB = (value) => {
     return 1 << (31 - Math.clz32(value));
 };
 exports.getMSB = getMSB;
+/**
+ * The `rangeCheck` function in TypeScript is used to validate if an index is within a specified range
+ * and throws a `RangeError` with a custom message if it is out of bounds.
+ * @param {number} index - The `index` parameter represents the value that you want to check if it
+ * falls within a specified range.
+ * @param {number} min - The `min` parameter represents the minimum value that the `index` should be
+ * compared against in the `rangeCheck` function.
+ * @param {number} max - The `max` parameter in the `rangeCheck` function represents the maximum value
+ * that the `index` parameter is allowed to have. If the `index` is greater than this `max` value, a
+ * `RangeError` will be thrown.
+ * @param [message=Index out of bounds.] - The `message` parameter is a string that represents the
+ * error message to be thrown if the index is out of bounds. By default, if no message is provided when
+ * calling the `rangeCheck` function, the message "Index out of bounds." will be used.
+ */
 const rangeCheck = (index, min, max, message = 'Index out of bounds.') => {
     if (index < min || index > max)
         throw new RangeError(message);
 };
 exports.rangeCheck = rangeCheck;
+/**
+ * The function `throwRangeError` throws a RangeError with a custom message if called.
+ * @param [message=The value is off-limits.] - The `message` parameter is a string that represents the
+ * error message to be displayed when a `RangeError` is thrown. If no message is provided, the default
+ * message is 'The value is off-limits.'.
+ */
 const throwRangeError = (message = 'The value is off-limits.') => {
     throw new RangeError(message);
 };
 exports.throwRangeError = throwRangeError;
+/**
+ * The function `isWeakKey` checks if the input is an object or a function in TypeScript.
+ * @param {unknown} input - The `input` parameter in the `isWeakKey` function is of type `unknown`,
+ * which means it can be any type. The function checks if the `input` is an object (excluding `null`)
+ * or a function, and returns a boolean indicating whether the `input` is a weak
+ * @returns The function `isWeakKey` returns a boolean value indicating whether the input is an object
+ * or a function.
+ */
 const isWeakKey = (input) => {
     const inputType = typeof input;
     return (inputType === 'object' && input !== null) || inputType === 'function';
 };
 exports.isWeakKey = isWeakKey;
+/**
+ * The function `calcMinUnitsRequired` calculates the minimum number of units required to accommodate a
+ * given total quantity based on a specified unit size.
+ * @param {number} totalQuantity - The `totalQuantity` parameter represents the total quantity of items
+ * that need to be processed or handled.
+ * @param {number} unitSize - The `unitSize` parameter represents the size of each unit or package. It
+ * is used in the `calcMinUnitsRequired` function to calculate the minimum number of units required to
+ * accommodate a total quantity of items.
+ */
 const calcMinUnitsRequired = (totalQuantity, unitSize) => Math.floor((totalQuantity + unitSize - 1) / unitSize);
 exports.calcMinUnitsRequired = calcMinUnitsRequired;
+/**
+ * The `roundFixed` function in TypeScript rounds a number to a specified number of decimal places.
+ * @param {number} num - The `num` parameter is a number that you want to round to a certain number of
+ * decimal places.
+ * @param {number} [digit=10] - The `digit` parameter in the `roundFixed` function specifies the number
+ * of decimal places to round the number to. By default, it is set to 10 if not provided explicitly.
+ * @returns The function `roundFixed` returns a number that is rounded to the specified number of
+ * decimal places (default is 10 decimal places).
+ */
 const roundFixed = (num, digit = 10) => {
     const multiplier = Math.pow(10, digit);
     return Math.round(num * multiplier) / multiplier;
 };
 exports.roundFixed = roundFixed;
-function isComparable(key) {
-    const keyType = typeof key;
-    if (keyType === 'number')
-        return !isNaN(key);
-    if (keyType === 'string')
-        return true;
-    if (keyType === 'bigint')
-        return true;
-    if (keyType === 'boolean')
-        return true;
-    if (keyType === 'symbol')
+/**
+ * The function `isPrimitiveComparable` checks if a value is a primitive type that can be compared.
+ * @param {unknown} value - The `value` parameter in the `isPrimitiveComparable` function is of type
+ * `unknown`, which means it can be any type. The function checks if the `value` is a primitive type
+ * that can be compared, such as number, bigint, string, or boolean.
+ * @returns The function `isPrimitiveComparable` returns a boolean value indicating whether the input
+ * `value` is a primitive value that can be compared using standard comparison operators (<, >, <=,
+ * >=).
+ */
+function isPrimitiveComparable(value) {
+    const valueType = typeof value;
+    if (valueType === 'number')
+        return !Number.isNaN(value);
+    return valueType === 'bigint' || valueType === 'string' || valueType === 'boolean';
+}
+/**
+ * The function `tryObjectToPrimitive` attempts to convert an object to a comparable primitive value by
+ * first checking the `valueOf` method and then the `toString` method.
+ * @param {object} obj - The `obj` parameter in the `tryObjectToPrimitive` function is an object that
+ * you want to convert to a primitive value. The function attempts to convert the object to a primitive
+ * value by first checking if the object has a `valueOf` method. If the `valueOf` method exists, it
+ * @returns The function `tryObjectToPrimitive` returns a value of type `ComparablePrimitive` if a
+ * primitive comparable value is found within the object, or a string value if the object has a custom
+ * `toString` method that does not return `'[object Object]'`. If neither condition is met, the
+ * function returns `null`.
+ */
+function tryObjectToPrimitive(obj) {
+    if (typeof obj.valueOf === 'function') {
+        const valueOfResult = obj.valueOf();
+        if (valueOfResult !== obj) {
+            if (isPrimitiveComparable(valueOfResult))
+                return valueOfResult;
+            if (typeof valueOfResult === 'object' && valueOfResult !== null)
+                return tryObjectToPrimitive(valueOfResult);
+        }
+    }
+    if (typeof obj.toString === 'function') {
+        const stringResult = obj.toString();
+        if (stringResult !== '[object Object]')
+            return stringResult;
+    }
+    return null;
+}
+/**
+ * The function `isComparable` in TypeScript checks if a value is comparable, handling primitive values
+ * and objects with optional force comparison.
+ * @param {unknown} value - The `value` parameter in the `isComparable` function represents the value
+ * that you want to check if it is comparable. It can be of any type (`unknown`), and the function will
+ * determine if it is comparable based on certain conditions.
+ * @param [isForceObjectComparable=false] - The `isForceObjectComparable` parameter in the
+ * `isComparable` function is a boolean flag that determines whether to treat non-primitive values as
+ * comparable objects. When set to `true`, it forces the function to consider non-primitive values as
+ * comparable objects, regardless of their type.
+ * @returns The function `isComparable` returns a boolean value indicating whether the `value` is
+ * considered comparable or not.
+ */
+function isComparable(value, isForceObjectComparable = false) {
+    if (value === null || value === undefined)
         return false;
-    if (keyType === 'undefined')
+    if (isPrimitiveComparable(value))
+        return true;
+    if (typeof value !== 'object')
         return false;
-    if (keyType === 'function')
-        return isComparable(key());
-    if (keyType === 'object') {
-        if (key === null)
-            return true;
-        // if (typeof key.valueOf === 'function') return isComparable(key.valueOf());   // This will keep recursing because every object has a valueOf method.
-        // if (typeof key.toString === 'function') return isComparable(key.toString()); // This will also keep recursing because every string type has a toString method.
+    if (value instanceof Date)
+        return !Number.isNaN(value.getTime());
+    if (isForceObjectComparable)
+        return true;
+    const comparableValue = tryObjectToPrimitive(value);
+    if (comparableValue === null || comparableValue === undefined)
         return false;
-    }
-    return false;
+    return isPrimitiveComparable(comparableValue);
 }
 //# sourceMappingURL=utils.js.map

package/dist/cjs/utils/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/utils/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;AA4GA,oCAiBC;AApHM,MAAM,MAAM,GAAG;IACpB,OAAO,sCAAsC,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC;QACvE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAChC,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;QACrC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AANW,QAAA,MAAM,UAMjB;AAEK,MAAM,WAAW,GAAG,UAAa,KAAU,EAAE,SAA0D;IAC5G,IAAI,CAAC,GAAG,CAAC,CAAC,EACR,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,OAAO,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC3C,GAAG,EAAE,CAAC;QACR,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAfW,QAAA,WAAW,eAetB;AAEW,QAAA,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAErC,MAAM,OAAO,GAAG,CAAC,SAAc,EAAE,EAAE;IACxC,OAAO,OAAO,SAAS,KAAK,UAAU,IAAI,SAAS,CAAC,SAAS,KAAK,oBAAY,CAAC;AACjF,CAAC,CAAC;AAFW,QAAA,OAAO,WAElB;AAEK,MAAM,OAAO,GAAG,CAAC,EAAa,EAAS,EAAE;IAC9C,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;IACzB,KAAK,CAAC,SAAS,GAAG,oBAAY,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAJW,QAAA,OAAO,WAIlB;AAEK,MAAM,UAAU,GAAG,CAAC,EAAS,EAAE,EAAE;IACtC,MAAM,IAAI,GAAG,CAAC,GAAG,IAA4B,EAAE,EAAE,CAAC,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAE7E,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,GAAG,IAA4B,EAAE,EAAE;QAClC,IAAI,MAAM,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAEzB,OAAO,IAAA,eAAO,EAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACvD,MAAM,GAAG,MAAM,EAAE,CAAC;QACpB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,EAAE,IAAI,EAAE,CACT,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,UAAU,cAerB;AAEK,MAAM,eAAe,GAAG,CAAC,EAAc,EAAE,EAAE;IAChD,MAAM,IAAI,GAAG,CAAC,GAAG,IAAiC,EAAE,EAAE,CAAC,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAElF,OAAO,MAAM,CAAC,MAAM,CAClB,CAAO,GAAG,IAAiC,EAAE,EAAE;QAC7C,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAE/B,OAAO,IAAA,eAAO,EAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACvD,MAAM,GAAG,MAAM,MAAM,EAAE,CAAC;QAC1B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAA,EACD,EAAE,IAAI,EAAE,CACT,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,eAAe,mBAe1B;AAEK,MAAM,MAAM,GAAG,CAAC,KAAa,EAAU,EAAE;IAC9C,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QACf,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AALW,QAAA,MAAM,UAKjB;AAEK,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAE,OAAO,GAAG,sBAAsB,EAAQ,EAAE;IAC5G,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG;QAAE,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB;AAEK,MAAM,eAAe,GAAG,CAAC,OAAO,GAAG,0BAA0B,EAAQ,EAAE;IAC5E,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAEK,MAAM,SAAS,GAAG,CAAC,KAAc,EAAmB,EAAE;IAC3D,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;IAC/B,OAAO,CAAC,SAAS,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,IAAI,SAAS,KAAK,UAAU,CAAC;AAChF,CAAC,CAAC;AAHW,QAAA,SAAS,aAGpB;AAEK,MAAM,oBAAoB,GAAG,CAAC,aAAqB,EAAE,QAAgB,EAAE,EAAE,CAC9E,IAAI,CAAC,KAAK,CAAC,CAAC,aAAa,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;AAD3C,QAAA,oBAAoB,wBACuB;AAEjD,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,QAAgB,EAAE,EAAE,EAAE;IAC5D,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACvC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,UAAU,CAAC;AACnD,CAAC,CAAC;AAHW,QAAA,UAAU,cAGrB;AAEF,SAAgB,YAAY,CAAC,GAAQ;IACnC,MAAM,OAAO,GAAG,OAAO,GAAG,CAAC;IAC3B,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACtC,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACtC,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACvC,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACvC,IAAI,OAAO,KAAK,WAAW;QAAE,OAAO,KAAK,CAAC;IAC1C,IAAI,OAAO,KAAK,UAAU;QAAE,OAAO,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC;IACvD,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACzB,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAC9B,sJAAsJ;QACtJ,iKAAiK;QACjK,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/utils/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;AA+QA,oCAUC;AAhRD;;;;;GAKG;AACI,MAAM,MAAM,GAAG;IACpB,OAAO,sCAAsC,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC;QACvE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAChC,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;QACrC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AANW,QAAA,MAAM,UAMjB;AAEF;;;;;;;;GAQG;AACI,MAAM,WAAW,GAAG,UAAa,KAAU,EAAE,SAA0D;IAC5G,IAAI,CAAC,GAAG,CAAC,CAAC,EACR,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,OAAO,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC3C,GAAG,EAAE,CAAC;QACR,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAfW,QAAA,WAAW,eAetB;AAEW,QAAA,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE5C;;;;;;;;GAQG;AACI,MAAM,OAAO,GAAG,CAAC,SAAc,EAAE,EAAE;IACxC,OAAO,OAAO,SAAS,KAAK,UAAU,IAAI,SAAS,CAAC,SAAS,KAAK,oBAAY,CAAC;AACjF,CAAC,CAAC;AAFW,QAAA,OAAO,WAElB;AAEF;;;;;;;GAOG;AACI,MAAM,OAAO,GAAG,CAAC,EAAa,EAAS,EAAE;IAC9C,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;IACzB,KAAK,CAAC,SAAS,GAAG,oBAAY,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAJW,QAAA,OAAO,WAIlB;AAEF;;;;;;;;;GASG;AACI,MAAM,UAAU,GAAG,CAAC,EAAS,EAAE,EAAE;IACtC,MAAM,IAAI,GAAG,CAAC,GAAG,IAA4B,EAAqB,EAAE,CAAC,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAEhG,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,GAAG,IAA4B,EAAE,EAAE;QAClC,IAAI,MAAM,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAEzB,OAAO,IAAA,eAAO,EAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACvD,MAAM,GAAG,MAAM,EAAE,CAAC;QACpB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,EAAE,IAAI,EAAE,CACT,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,UAAU,cAerB;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,eAAe,GAAG,CAAC,EAAc,EAAE,EAAE;IAChD,MAAM,IAAI,GAAG,CAAC,GAAG,IAAiC,EAA0B,EAAE,CAAC,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAE1G,OAAO,MAAM,CAAC,MAAM,CAClB,CAAO,GAAG,IAAiC,EAAE,EAAE;QAC7C,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAE/B,OAAO,IAAA,eAAO,EAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACvD,MAAM,GAAG,MAAM,MAAM,EAAE,CAAC;QAC1B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAA,EACD,EAAE,IAAI,EAAE,CACT,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,eAAe,mBAe1B;AAEF;;;;;;;;GAQG;AACI,MAAM,MAAM,GAAG,CAAC,KAAa,EAAU,EAAE;IAC9C,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QACf,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AALW,QAAA,MAAM,UAKjB;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAE,OAAO,GAAG,sBAAsB,EAAQ,EAAE;IAC5G,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG;QAAE,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB;AAEF;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAC,OAAO,GAAG,0BAA0B,EAAQ,EAAE;IAC5E,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAEF;;;;;;;GAOG;AACI,MAAM,SAAS,GAAG,CAAC,KAAc,EAAmB,EAAE;IAC3D,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;IAC/B,OAAO,CAAC,SAAS,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,IAAI,SAAS,KAAK,UAAU,CAAC;AAChF,CAAC,CAAC;AAHW,QAAA,SAAS,aAGpB;AAEF;;;;;;;;GAQG;AACI,MAAM,oBAAoB,GAAG,CAAC,aAAqB,EAAE,QAAgB,EAAE,EAAE,CAC9E,IAAI,CAAC,KAAK,CAAC,CAAC,aAAa,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;AAD3C,QAAA,oBAAoB,wBACuB;AAExD;;;;;;;;GAQG;AACI,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,QAAgB,EAAE,EAAE,EAAE;IAC5D,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACvC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,UAAU,CAAC;AACnD,CAAC,CAAC;AAHW,QAAA,UAAU,cAGrB;AAEF;;;;;;;;GAQG;AACH,SAAS,qBAAqB,CAAC,KAAc;IAC3C,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;IAC/B,IAAI,SAAS,KAAK,QAAQ;QAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxD,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,SAAS,CAAC;AACrF,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACvC,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QACtC,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,aAAa,KAAK,GAAG,EAAE,CAAC;YAC1B,IAAI,qBAAqB,CAAC,aAAa,CAAC;gBAAE,OAAO,aAAa,CAAC;YAC/D,IAAI,OAAO,aAAa,KAAK,QAAQ,IAAI,aAAa,KAAK,IAAI;gBAAE,OAAO,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;IACD,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QACvC,MAAM,YAAY,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,YAAY,KAAK,iBAAiB;YAAE,OAAO,YAAY,CAAC;IAC9D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,YAAY,CAAC,KAAc,EAAE,uBAAuB,GAAG,KAAK;IAC1E,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,qBAAqB,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACjE,IAAI,uBAAuB;QAAE,OAAO,IAAI,CAAC;IACzC,MAAM,eAAe,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACpD,IAAI,eAAe,KAAK,IAAI,IAAI,eAAe,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC5E,OAAO,qBAAqB,CAAC,eAAe,CAAC,CAAC;AAChD,CAAC"}

package/dist/mjs/data-structures/base/iterable-element-base.d.ts

@@ -16,10 +16,6 @@ export declare abstract class IterableElementBase<E, R, C> {
      * `_toElementFn`.
      */
     get toElementFn(): ((rawElement: R) => E) | undefined;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -30,10 +26,6 @@ export declare abstract class IterableElementBase<E, R, C> {
      * parameter is used to pass any number of arguments to the `_getIterator` method.
      */
     [Symbol.iterator](...args: any[]): IterableIterator<E>;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -41,10 +33,6 @@ export declare abstract class IterableElementBase<E, R, C> {
      * The function returns an iterator that yields all the values in the object.
      */
     values(): IterableIterator<E>;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -60,14 +48,6 @@ export declare abstract class IterableElementBase<E, R, C> {
      * the array satisfies the provided predicate function, and `false` otherwise.
      */
     every(predicate: ElementCallback<E, R, boolean, C>, thisArg?: any): boolean;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -83,10 +63,6 @@ export declare abstract class IterableElementBase<E, R, C> {
      * in the collection, and false otherwise.
      */
     some(predicate: ElementCallback<E, R, boolean, C>, thisArg?: any): boolean;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -101,10 +77,6 @@ export declare abstract class IterableElementBase<E, R, C> {
      * be passed as the `this` value to the `callbackfn` function. If `thisArg
      */
     forEach(callbackfn: ElementCallback<E, R, void, C>, thisArg?: any): void;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -133,10 +105,6 @@ export declare abstract class IterableElementBase<E, R, C> {
      * otherwise.
      */
     has(element: E): boolean;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -151,17 +119,13 @@ export declare abstract class IterableElementBase<E, R, C> {
      * all the elements in the array and applying the callback function to each element.
      */
     reduce<U>(callbackfn: ReduceElementCallback<E, R, U, C>, initialValue: U): U;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
      * The print function logs the elements of an array to the console.
      */
-    print(): void;
+    print(): E[];
     abstract isEmpty(): boolean;
     abstract clear(): void;
     abstract clone(): C;

package/dist/mjs/data-structures/base/iterable-element-base.js

@@ -24,10 +24,6 @@ export class IterableElementBase {
     get toElementFn() {
         return this._toElementFn;
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -40,10 +36,6 @@ export class IterableElementBase {
     *[Symbol.iterator](...args) {
         yield* this._getIterator(...args);
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -55,10 +47,6 @@ export class IterableElementBase {
             yield item;
         }
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -82,14 +70,6 @@ export class IterableElementBase {
         }
         return true;
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -113,10 +93,6 @@ export class IterableElementBase {
         }
         return false;
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -136,10 +112,6 @@ export class IterableElementBase {
             callbackfn.call(thisArg, item, index++, this);
         }
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -181,10 +153,6 @@ export class IterableElementBase {
         }
         return false;
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -206,10 +174,6 @@ export class IterableElementBase {
         }
         return accumulator;
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -217,6 +181,6 @@ export class IterableElementBase {
      * The print function logs the elements of an array to the console.
      */
     print() {
-        console.log([...this]);
+        return [...this];
     }
 }

package/dist/mjs/data-structures/base/iterable-entry-base.d.ts

@@ -1,9 +1,5 @@
 import { EntryCallback, ReduceEntryCallback } from '../../types';
 export declare abstract class IterableEntryBase<K = any, V = any> {
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     abstract get size(): number;
     /**
      * Time Complexity: O(n)
@@ -15,10 +11,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * parameter is used to pass any additional arguments to the `_getIterator` method.
      */
     [Symbol.iterator](...args: any[]): IterableIterator<[K, V]>;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -27,10 +19,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * be undefined.
      */
     entries(): IterableIterator<[K, V | undefined]>;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -38,10 +26,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * The function returns an iterator that yields the keys of a data structure.
      */
     keys(): IterableIterator<K>;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -49,10 +33,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * The function returns an iterator that yields the values of a collection.
      */
     values(): IterableIterator<V>;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -68,10 +48,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * the collection satisfies the provided predicate function, and `false` otherwise.
      */
     every(predicate: EntryCallback<K, V, boolean>, thisArg?: any): boolean;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -88,14 +64,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * the collection, and false otherwise.
      */
     some(predicate: EntryCallback<K, V, boolean>, thisArg?: any): boolean;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -110,10 +78,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * used as the `this` value when calling the callback function. If `thisArg` is not provided, `
      */
     forEach(callbackfn: EntryCallback<K, V, void>, thisArg?: any): void;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -131,11 +95,7 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * the provided callback function. If no element satisfies the callback function, `undefined` is
      * returned.
      */
-    find(callbackfn: EntryCallback<K, V, [K, V]>, thisArg?: any): [K, V] | undefined;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
+    find(callbackfn: EntryCallback<K, V, boolean>, thisArg?: any): [K, V] | undefined;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -147,10 +107,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * otherwise.
      */
     has(key: K): boolean;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -161,10 +117,6 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * @returns a boolean value, either true or false.
      */
     hasValue(value: V): boolean;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -193,17 +145,13 @@ export declare abstract class IterableEntryBase<K = any, V = any> {
      * all the elements in the collection.
      */
     reduce<U>(callbackfn: ReduceEntryCallback<K, V, U>, initialValue: U): U;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
      * The print function logs the elements of an array to the console.
      */
-    print(): void;
+    print(): [K, V][] | string;
     abstract isEmpty(): boolean;
     abstract clear(): void;
     abstract clone(): any;