@nejs/basic-extensions 2.21.5 → 2.22.6

package/dist/cjs/big.int.extension.js

@@ -1,273 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BigIntPrototypeExtensions = exports.BigIntExtensions = void 0;
-const extension_1 = require("@nejs/extension");
-/**
- * `BigIntExtensions` is a patch for the JavaScript built-in `BigInt` class.
- * It adds utility methods to the `BigInt` class without modifying the global
- * namespace directly. This patch includes methods for checking if a value is
- * a `BigInt` and conditionally returning a value based on whether the supplied
- * value is a `BigInt` or not.
- *
- * @type {Patch}
- * @example
- * import { BigIntExtensions } from 'big.int.extension.js'
- *
- * BigIntExtensions.apply()
- * // Now the `BigInt` class has additional methods available
- */
-exports.BigIntExtensions = new extension_1.Patch(BigInt, {
-    [extension_1.Patch.kMutablyHidden]: {
-        /**
-         * Checks if all or some of the supplied values are numbers.
-         *
-         * This method uses the `Array.prototype.every` or `Array.prototype.some`
-         * method to check if all or some of the supplied values are numbers,
-         * respectively. The method to use is determined by the `which` parameter.
-         *
-         * @param {string} [which='every'] - Determines the method to use for the
-         * check. Can be either 'every' or 'some'. Defaults to 'every'.
-         * @param {...*} values - The values to check.
-         * @returns {boolean} - Returns `true` if all or some of the values are
-         * numbers (based on the `which` parameter), `false` otherwise.
-         *
-         * @example
-         * areNumbers('every', 1, 2, 3) // true
-         * areNumbers('some', 1, '2', 3) // true
-         * areNumbers('every', 1, '2', 3) // false
-         */
-        areBigInts(which = ['every', 'some'][0], ...values) {
-            if (which !== 'every' && which !== 'some') {
-                return false;
-            }
-            return values[which](num => this.isBigInt(num));
-        },
-        /**
-         * Determines if the supplied `value` is a `BigInt`. This check is
-         * performed by first checking the `typeof` the `value` and then
-         * checking to see if the `value` is an `instanceof` `BigInt`
-         *
-         * @param {*} value The value that needs to be checked to determine
-         * if it is a `BigInt` or not
-         * @returns {boolean} `true` if the supplied `value` is a `BigInt`,
-         * `false` otherwise
-         *
-         * @example
-         * const bigInt = 1234567890123456789012345678901234567890n
-         * isBigInt(bigInt) // true
-         * isBigInt(1234567890123456789012345678901234567890) // false
-         * isBigInt('1234567890123456789012345678901234567890') // false
-         * isBigInt(BigInt('1234567890123456789012345678901234567890')) // true
-         */
-        isBigInt(value) {
-            return typeof value === 'bigint' || value instanceof BigInt;
-        },
-        /**
-         * Conditionally returns a value based on whether the supplied
-         * `value` is a `BigInt` or not. If the `value` is a `BigInt`,
-         * the `thenValue` will be returned. If it is not a `BigInt`,
-         * the `elseValue` will be returned instead.
-         *
-         * @param {any} value The value to check to determine if it is a
-         * `BigInt`
-         * @param {any} thenValue The value to return if the supplied
-         * `value` is a `BigInt`
-         * @param {any} elseValue The value to return if the supplied
-         * `value` is not a `BigInt`
-         * @returns {any} Either the `thenValue` or `elseValue` depending
-         * on if the supplied `value` is a `BigInt`
-         *
-         * @example
-         * const bigInt = 1234567890123456789012345678901234567890n
-         * const num = 42
-         * ifBigInt(bigInt, 'is a BigInt', 'not a BigInt')
-         * // 'is a BigInt'
-         * ifBigInt(num, 'is a BigInt', 'not a BigInt')
-         * // 'not a BigInt'
-         */
-        ifBigInt(value, thenValue, elseValue) {
-            return isThenElse(this.isBigInt(value), thenValue, elseValue);
-        },
-        /**
-         * The Math.min() static method returns the smallest of the numbers given
-         * as input parameters, or Infinity if there are no parameters.
-         *
-         * @param {bigint|number} values value1, …, valueN – Zero or more numbers
-         * among which the lowest value will be selected and returned.
-         * @returns {bigint|number|Infinity} The smallest of the given numbers.
-         * Returns Infinity if no parameters are provided.
-         */
-        min(...values) {
-            const sorter = (l, r) => l < r ? -1 : l > r ? 1 : 0;
-            if (!values.length)
-                return Infinity;
-            if (values.every(n => typeof n === 'bigint')) {
-                return values.toSorted(sorter).at(0);
-            }
-            else {
-                throw new TypeError('All supplied values must be of type bigint');
-            }
-        },
-        /**
-         * The Math.max() static method returns the largest of the numbers given
-         * as input parameters, or Infinity if there are no parameters.
-         *
-         * @param {bigint|number} values value1, …, valueN – Zero or more numbers
-         * among which the largest value will be selected and returned.
-         * @returns {bigint|number|Infinity} The largest of the given numbers.
-         * Returns Infinity if no parameters are provided.
-         */
-        max(...values) {
-            const sorter = (l, r) => l < r ? -1 : l > r ? 1 : 0;
-            if (!values.length)
-                return Infinity;
-            if (values.every(n => typeof n === 'bigint')) {
-                return values.toSorted(sorter).at(-1);
-            }
-            else {
-                throw new TypeError('All supplied values must be of type bigint');
-            }
-        },
-    },
-});
-const { isBigInt: pIsBigInt, ifBigInt: pIfBigInt } = exports.BigIntExtensions.patches;
-/**
- * `BigIntPrototypeExtensions` is a patch for the JavaScript built-in
- * `BigInt.prototype`. It adds utility methods to the `BigInt` prototype
- * without modifying the global namespace directly. This patch includes
- * methods for checking if a value is a BigInt and conditionally returning
- * a value based on whether the supplied value is a BigInt or not.
- *
- * @type {Patch}
- * @example
- * import { BigIntPrototypeExtensions } from 'big.int.extension.js'
- *
- * BigIntPrototypeExtensions.apply()
- * // Now the `BigInt` prototype has additional methods available
- */
-exports.BigIntPrototypeExtensions = new extension_1.Patch(BigInt.prototype, {
-    /**
-     * Clamps a value between a minimum and maximum value.
-     *
-     * This method checks if the provided value and the min and max bounds are
-     * numbers. If they are not, it returns the original value. If they are,
-     * it ensures that the value does not go below the minimum value or above
-     * the maximum value.
-     *
-     * @param {bigint} [minValue=BigInt(-Number.MAX_VALUE)] - The minimum value.
-     * Defaults to BigInt(-Number.MAX_VALUE).
-     * @param {bigint} [maxValue=BigInt(Number.MAX_VALUE)] - The maximum value.
-     * Defaults to BigInt(Number.MAX_VALUE).
-     * @returns {bigint} - Returns the clamped value if all parameters are
-     * big integers.
-     *
-     * @example
-     * (10n).clamp(1n, 5n) // returns 5n
-     * (-10n).clamp(1n, 5n) // returns 1n
-     * (3n).clamp(1n, 5n) // returns 3n
-     */
-    clamp(minValue = BigInt(-Number.MAX_VALUE), maxValue = BigInt(Number.MAX_VALUE)) {
-        if (typeof minValue !== 'bigint' || typeof maxValue !== 'bigint')
-            throw new TypeError('All values must be big integers');
-        return BigInt.max(minValue, BigInt.min(maxValue, this));
-    },
-    /**
-     * A getter method that returns an object representation of the BigInt
-     * instance.
-     *
-     * This method wraps the BigInt instance in an object, allowing it to be
-     * treated as an object. The returned object is created using the `Object()`
-     * constructor, which takes the BigInt instance as its argument.
-     *
-     * @type {Object}
-     * @readonly
-     *
-     * @example
-     * const bigInt = 1234567890123456789012345678901234567890n
-     * console.log(typeof bigInt)           // 'bigint'
-     * console.log(typeof bigInt.instance)  // 'object'
-     */
-    get instance() {
-        return Object(this);
-    },
-    /**
-     * A getter method that checks if the current instance is a BigInt.
-     *
-     * This method uses the `pIsBigInt` function from the `BigIntExtensions`
-     * patch to determine if the current instance (`this`) is a BigInt.
-     *
-     * @type {boolean}
-     * @readonly
-     *
-     * @example
-     * const bigInt = 1234567890123456789012345678901234567890n
-     * console.log(bigInt.isBigInt) // Output: true
-     *
-     * const notBigInt = 42
-     * console.log(notBigInt.isBigInt) // Output: false
-     */
-    get isBigInt() {
-        return pIsBigInt(this);
-    },
-    /**
-     * Checks if the current object is a BigInt and returns the corresponding
-     * value based on the result.
-     *
-     * This method uses the `pIfBigInt` function from the `BigIntExtensions`
-     * patch to determine if the current object (`this`) is a BigInt. If it is
-     * a BigInt, the `thenValue` is returned. Otherwise, the `elseValue` is
-     * returned.
-     *
-     * @param {any} thenValue - The value to return if the current object
-     * is a BigInt.
-     * @param {any} elseValue - The value to return if the current object
-     * is not a BigInt.
-     * @returns {any} The `thenValue` if the current object is a BigInt, or
-     * the `elseValue` if it is not a BigInt.
-     *
-     * @example
-     * const bigInt = 1234567890123456789012345678901234567890n
-     * // 'Is a BigInt'
-     * console.log(bigInt.ifBigInt('Is a BigInt', 'Not a BigInt'))
-     *
-     * const notBigInt = 42
-     * // 'Not a BigInt'
-     * console.log(notBigInt.ifBigInt('Is a BigInt', 'Not a BigInt'))
-     */
-    ifBigInt(thenValue, elseValue) {
-        return pIfBigInt(this, thenValue, elseValue);
-    },
-    /**
-     * Provides a way when dealing with numbers to determine if
-     * a given number is within a range of values. By default, if
-     * no parameters are supplied, it always returns true since
-     * the default range is -Infinity to +Infinity. Additionally,
-     * by default, the number will always be less than the supplied
-     * max unless inclusive is set to true.
-     *
-     * @param min the lower range value, defaults to -Infinity
-     * @param max the upper range value, defaults to +Infinity
-     * @param inclusive defaults to false, set to true if you
-     * want the max value to less than and equals to
-     * @returns {boolean} true if within the range, false otherwise
-     */
-    within(min = BigInt(-Infinity), max = BigInt(Infinity), inclusive = false) {
-        return this >= min && (inclusive ? this <= max : this < max);
-    }
-});
-// NOTE to self; this is repeated here otherwise a circular reference from
-// Object<->Function<->Global occurs. See original source in global.this.js
-// {@see globalThis.isThenElse}
-function isThenElse(bv, tv, ev) {
-    function isFunction(value) { typeof value === 'function'; }
-    if (arguments.length > 1) {
-        var _then = isFunction(tv) ? tv(bv) : tv;
-        if (arguments.length > 2) {
-            var _else = isFunction(ev) ? tv(bv) : ev;
-            return bv ? _then : _else;
-        }
-        return bv || _then;
-    }
-    return bv;
-}
-//# sourceMappingURL=big.int.extension.js.map

package/dist/cjs/big.int.extension.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"big.int.extension.js","sourceRoot":"","sources":["../../src/big.int.extension.js"],"names":[],"mappings":";;;AAAA,+CAAuC;AAEvC;;;;;;;;;;;;;GAaG;AACU,QAAA,gBAAgB,GAAG,IAAI,iBAAK,CAAC,MAAM,EAAE;IAChD,CAAC,iBAAK,CAAC,cAAc,CAAC,EAAE;QACtB;;;;;;;;;;;;;;;;;WAiBG;QACH,UAAU,CAAC,KAAK,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM;YAChD,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBAC1C,OAAO,KAAK,CAAA;YACd,CAAC;YAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;QACjD,CAAC;QAED;;;;;;;;;;;;;;;;WAgBG;QACH,QAAQ,CAAC,KAAK;YACZ,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,CAAA;QAC7D,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS;YAClC,OAAO,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;QAC/D,CAAC;QAED;;;;;;;;WAQG;QACH,GAAG,CAAC,GAAG,MAAM;YACX,MAAM,MAAM,GAAG,CAAC,CAAC,EAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAElD,IAAI,CAAC,MAAM,CAAC,MAAM;gBAChB,OAAO,QAAQ,CAAA;YAEjB,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;gBAC7C,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YACtC,CAAC;iBACI,CAAC;gBACJ,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAA;YACnE,CAAC;QACH,CAAC;QAED;;;;;;;;WAQG;QACH,GAAG,CAAC,GAAG,MAAM;YACX,MAAM,MAAM,GAAG,CAAC,CAAC,EAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAElD,IAAI,CAAC,MAAM,CAAC,MAAM;gBAChB,OAAO,QAAQ,CAAA;YAEjB,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;gBAC7C,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YACvC,CAAC;iBACI,CAAC;gBACJ,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAA;YACnE,CAAC;QACH,CAAC;KACF;CACF,CAAC,CAAA;AAEF,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,wBAAgB,CAAC,OAAO,CAAA;AAE7E;;;;;;;;;;;;;GAaG;AACU,QAAA,yBAAyB,GAAG,IAAI,iBAAK,CAAC,MAAM,CAAC,SAAS,EAAE;IACnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CACH,QAAQ,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,EACpC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;QAEnC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC9D,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAA;QAExD,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,QAAQ;QACV,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,QAAQ;QACV,OAAO,SAAS,CAAC,IAAI,CAAC,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS;QAC3B,OAAO,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,GAAG,GAAG,MAAM,CAAC,CAAC,QAAQ,CAAC,EACvB,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,EACtB,SAAS,GAAG,KAAK;QAEjB,OAAO,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,CAAA;IAC9D,CAAC;CACF,CAAC,CAAA;AAEF,0EAA0E;AAC1E,2EAA2E;AAC3E,+BAA+B;AAC/B,SAAS,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;IAC5B,SAAS,UAAU,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,UAAU,CAAA,CAAC,CAAC;IAE1D,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,IAAI,KAAK,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnE,IAAI,KAAK,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;QACrE,CAAC;QAAC,OAAO,EAAE,IAAI,KAAK,CAAC;IACvB,CAAC;IAAC,OAAO,EAAE,CAAA;AACb,CAAC"}

package/dist/cjs/classes/asyncIterable.d.ts

@@ -1,126 +0,0 @@
-/**
- * The AsyncIterable class extends the concept of Iterable to asynchronous
- * operations. It allows creating iterable objects where each element can be
- * an asynchronous entity, like a Promise. This class is particularly useful
- * when dealing with asynchronous data sources, such as API responses, file
- * reading in chunks, or any other data that is not immediately available but
- * arrives over time.
- */
-export class AsyncIterable {
-    /**
-     * Checks if a given value is an async iterable. This method determines if
-     * the provided value has a `Symbol.asyncIterator` property that is an async
-     * generator function. It's a precise way to identify if the value conforms
-     * to the async iterable protocol using an async generator function.
-     *
-     * Note: This method specifically checks for async generator functions. Some
-     * async iterables might use regular async functions that return an async
-     * iterator, which this method won't identify.
-     *
-     * @param {*} value - The value to be checked for async iterability.
-     * @returns {boolean} - Returns true if the value is an async iterable
-     * implemented using an async generator function, false otherwise.
-     */
-    static isAsyncIterable(value: any): boolean;
-    /**
-     * Constructs an instance of AsyncIterable. Similar to Iterable, it can be
-     * initialized with either an iterable object, an async generator function,
-     * or individual elements. The elements can be promises, direct values, or a
-     * mix of both. If the first argument is an iterable or an async generator
-     * function, the instance is initialized with the elements from the iterable
-     * or the generated elements from the async generator function, followed by
-     * any additional arguments. If the first argument is not an iterable or an
-     * async generator function, all arguments are treated as individual elements.
-     *
-     * @param {Iterable|AsyncGeneratorFunction|Promise|*} elementsOrFirstElement -
-     * An iterable object, an async generator function, a Promise, or the first
-     * element.
-     * @param {...Promise|*} moreElements - Additional elements if the first
-     * argument is not an iterable or an async generator function.
-     */
-    constructor(elementsOrFirstElement: Iterable<any> | AsyncGeneratorFunction | Promise<any> | any, ...moreElements: (Promise<any> | any)[]);
-    /**
-     * Implements the async iterable protocol. When an instance of AsyncIterable
-     * is used in a `for await...of` loop, this async generator function is
-     * invoked. It yields each element as a Promise, allowing asynchronous
-     * iteration. Elements that are not Promises are automatically wrapped in
-     * a resolved Promise to ensure consistency.
-     *
-     * @returns {AsyncGenerator} An async generator that yields each element as
-     * a Promise.
-     */
-    [Symbol.asyncIterator](): AsyncGenerator;
-    /**
-     * Ensures that the constructor of this object instance's name
-     * is returned if the string tag for this instance is queried
-     *
-     * @returns {string} the name of the class
-     */
-    get [Symbol.toStringTag](): string;
-    #private;
-}
-/**
- * Being able to create a compliant `AsyncIterator` around any type of
- * iterable object. This can be wrapped around any type of object that
- * has a `[Symbol.asyncIterator]` property assigned to a generator
- * function.
- */
-export class AsyncIterator {
-    /**
-     * Creates a new `AsyncIterator` object instance.
-     *
-     * @param {object|AsyncGeneratorFunction} asyncIterable any object that has a
-     * `[Symbol.asyncIterable]` property assigned to a generator function or an
-     * async generator function itself.
-     */
-    constructor(asyncIterable: object | AsyncGeneratorFunction);
-    /**
-     * Returns a new `Array` derived from the iterable this object
-     * wraps.
-     *
-     * @returns {array} a new `Array` generated from the wrapped
-     * iterable. The method is generated from using an async for of
-     * loop.
-     */
-    asArray(): any[];
-    /**
-     * Returns the actual iterable object passed to the constructor that
-     * created this instance.
-     *
-     * @returns {object} the object containing the `[Symbol.iterator]`
-     */
-    get asyncIterable(): object;
-    /**
-     * The function retrieves the next value in the iterator. If the
-     * the iterator has run its course, `reset()` can be invoked to
-     * reset the pointer to the beginning of the iteration.
-     *
-     * @returns {any} the next value
-     */
-    next(): any;
-    /**
-     * Resets the async iterator to the beginning allowing it to be
-     * iterated over again.
-     */
-    reset(): Promise<void>;
-    /**
-     * The existence of this symbol on the object instances, indicates that
-     * it can be used in `for(.. of ..)` loops and its values can be
-     * extracted from calls to `Array.from()`
-     *
-     * @returns {AsyncIterable} this is returned since this object is already
-     * conforming to the expected JavaScript AsyncIterator interface
-     */
-    [Symbol.asyncIterator](): AsyncIterable;
-    /**
-     * Ensures that the constructor of this object instance's name
-     * is returned if the string tag for this instance is queried
-     *
-     * @returns {string} the name of the class
-     */
-    get [Symbol.toStringTag](): string;
-    #private;
-}
-export const AsyncIterableExtensions: Extension;
-export const AsyncIteratorExtensions: Extension;
-import { Extension } from '@nejs/extension';

package/dist/cjs/classes/asyncIterable.js

@@ -1,209 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AsyncIteratorExtensions = exports.AsyncIterableExtensions = exports.AsyncIterator = exports.AsyncIterable = void 0;
-const extension_1 = require("@nejs/extension");
-/**
- * The AsyncIterable class extends the concept of Iterable to asynchronous
- * operations. It allows creating iterable objects where each element can be
- * an asynchronous entity, like a Promise. This class is particularly useful
- * when dealing with asynchronous data sources, such as API responses, file
- * reading in chunks, or any other data that is not immediately available but
- * arrives over time.
- */
-class AsyncIterable {
-    /**
-     * Private field to store the elements of the async iterable.
-     * @private
-     */
-    #elements = [];
-    /**
-     * Constructs an instance of AsyncIterable. Similar to Iterable, it can be
-     * initialized with either an iterable object, an async generator function,
-     * or individual elements. The elements can be promises, direct values, or a
-     * mix of both. If the first argument is an iterable or an async generator
-     * function, the instance is initialized with the elements from the iterable
-     * or the generated elements from the async generator function, followed by
-     * any additional arguments. If the first argument is not an iterable or an
-     * async generator function, all arguments are treated as individual elements.
-     *
-     * @param {Iterable|AsyncGeneratorFunction|Promise|*} elementsOrFirstElement -
-     * An iterable object, an async generator function, a Promise, or the first
-     * element.
-     * @param {...Promise|*} moreElements - Additional elements if the first
-     * argument is not an iterable or an async generator function.
-     */
-    constructor(elementsOrFirstElement, ...moreElements) {
-        if (elementsOrFirstElement != null &&
-            (typeof elementsOrFirstElement[Symbol.iterator] === 'function' ||
-                typeof elementsOrFirstElement[Symbol.asyncIterator] === 'function')) {
-            this.#elements = [...elementsOrFirstElement, ...moreElements];
-        }
-        else if (typeof elementsOrFirstElement === 'function' &&
-            elementsOrFirstElement.constructor.name === 'AsyncGeneratorFunction') {
-            this.#elements = elementsOrFirstElement();
-        }
-        else {
-            this.#elements = [elementsOrFirstElement, ...moreElements];
-        }
-    }
-    /**
-     * Implements the async iterable protocol. When an instance of AsyncIterable
-     * is used in a `for await...of` loop, this async generator function is
-     * invoked. It yields each element as a Promise, allowing asynchronous
-     * iteration. Elements that are not Promises are automatically wrapped in
-     * a resolved Promise to ensure consistency.
-     *
-     * @returns {AsyncGenerator} An async generator that yields each element as
-     * a Promise.
-     */
-    async *[Symbol.asyncIterator]() {
-        for await (const element of this.#elements) {
-            // No need to wrap as a promise here since `for await...of` can handle
-            // both Promises and non-Promise values.
-            yield element;
-        }
-    }
-    /**
-     * Ensures that the constructor of this object instance's name
-     * is returned if the string tag for this instance is queried
-     *
-     * @returns {string} the name of the class
-     */
-    get [Symbol.toStringTag]() {
-        return this.constructor.name;
-    }
-    /**
-     * Checks if a given value is an async iterable. This method determines if
-     * the provided value has a `Symbol.asyncIterator` property that is an async
-     * generator function. It's a precise way to identify if the value conforms
-     * to the async iterable protocol using an async generator function.
-     *
-     * Note: This method specifically checks for async generator functions. Some
-     * async iterables might use regular async functions that return an async
-     * iterator, which this method won't identify.
-     *
-     * @param {*} value - The value to be checked for async iterability.
-     * @returns {boolean} - Returns true if the value is an async iterable
-     * implemented using an async generator function, false otherwise.
-     */
-    static isAsyncIterable(value) {
-        const type = Object.prototype.toString.call(value?.[Symbol.asyncIterator]);
-        return type === '[object AsyncGeneratorFunction]';
-    }
-}
-exports.AsyncIterable = AsyncIterable;
-/**
- * Being able to create a compliant `AsyncIterator` around any type of
- * iterable object. This can be wrapped around any type of object that
- * has a `[Symbol.asyncIterator]` property assigned to a generator
- * function.
- */
-class AsyncIterator {
-    /**
-     * Creates a new `AsyncIterator` object instance.
-     *
-     * @param {object|AsyncGeneratorFunction} asyncIterable any object that has a
-     * `[Symbol.asyncIterable]` property assigned to a generator function or an
-     * async generator function itself.
-     */
-    constructor(asyncIterable) {
-        if (typeof asyncIterable === 'function' &&
-            asyncIterable.constructor.name === 'AsyncGeneratorFunction') {
-            this.#asyncIterable = asyncIterable();
-        }
-        else if (!asyncIterable ||
-            !Reflect.has(asyncIterable, Symbol.asyncIterator)) {
-            throw new TypeError('Value used to instantiate AsyncIterator is not an async iterable');
-        }
-        else {
-            this.#asyncIterable = asyncIterable;
-        }
-        this.#asyncIterator = this.#asyncIterable[Symbol.asyncIterator]();
-    }
-    /**
-     * Returns a new `Array` derived from the iterable this object
-     * wraps.
-     *
-     * @returns {array} a new `Array` generated from the wrapped
-     * iterable. The method is generated from using an async for of
-     * loop.
-     */
-    async asArray() {
-        const array = [];
-        for await (const value of this) {
-            array.push(value);
-        }
-        return array;
-    }
-    /**
-     * Returns the actual iterable object passed to the constructor that
-     * created this instance.
-     *
-     * @returns {object} the object containing the `[Symbol.iterator]`
-     */
-    get asyncIterable() {
-        return this.#asyncIterable;
-    }
-    /**
-     * The function retrieves the next value in the iterator. If the
-     * the iterator has run its course, `reset()` can be invoked to
-     * reset the pointer to the beginning of the iteration.
-     *
-     * @returns {any} the next value
-     */
-    async next() {
-        const result = await this.#asyncIterator.next();
-        if (result.done) {
-            return { value: undefined, done: true };
-        }
-        else {
-            return { value: result.value, done: false };
-        }
-    }
-    /**
-     * Resets the async iterator to the beginning allowing it to be
-     * iterated over again.
-     */
-    async reset() {
-        this.#asyncIterator = this.#asyncIterable[Symbol.asyncIterator]();
-    }
-    /**
-     * The existence of this symbol on the object instances, indicates that
-     * it can be used in `for(.. of ..)` loops and its values can be
-     * extracted from calls to `Array.from()`
-     *
-     * @returns {AsyncIterable} this is returned since this object is already
-     * conforming to the expected JavaScript AsyncIterator interface
-     */
-    [Symbol.asyncIterator]() {
-        return this;
-    }
-    /**
-     * Ensures that the constructor of this object instance's name
-     * is returned if the string tag for this instance is queried
-     *
-     * @returns {string} the name of the class
-     */
-    get [Symbol.toStringTag]() {
-        return this.constructor.name;
-    }
-    /**
-     * The object from which its iterator functionality is derived.
-     *
-     * @type {object}
-     * @private
-     */
-    #asyncIterable = null;
-    /**
-     * The results of a call to the iterable's `[Symbol.asyncIterator]`
-     * generator function.
-     *
-     * @type {object}
-     * @private
-     */
-    #asyncIterator = null;
-}
-exports.AsyncIterator = AsyncIterator;
-exports.AsyncIterableExtensions = new extension_1.Extension(AsyncIterable);
-exports.AsyncIteratorExtensions = new extension_1.Extension(AsyncIterator);
-//# sourceMappingURL=asyncIterable.js.map

package/dist/cjs/classes/asyncIterable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"asyncIterable.js","sourceRoot":"","sources":["../../../src/classes/asyncIterable.js"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C;;;;;;;GAOG;AACH,MAAa,aAAa;IACxB;;;OAGG;IACH,SAAS,GAAG,EAAE,CAAC;IAEf;;;;;;;;;;;;;;;OAeG;IACH,YAAY,sBAAsB,EAAE,GAAG,YAAY;QACjD,IACE,sBAAsB,IAAI,IAAI;YAC9B,CAAC,OAAO,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,UAAU;gBAC7D,OAAO,sBAAsB,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,UAAU,CAAC,EACpE,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,sBAAsB,EAAE,GAAG,YAAY,CAAC,CAAC;QAChE,CAAC;aAAM,IACL,OAAO,sBAAsB,KAAK,UAAU;YAC5C,sBAAsB,CAAC,WAAW,CAAC,IAAI,KAAK,wBAAwB,EACpE,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,sBAAsB,EAAE,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,CAAC,sBAAsB,EAAE,GAAG,YAAY,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAC3C,sEAAsE;YACtE,wCAAwC;YACxC,MAAM,OAAO,CAAC;QAChB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IAC9B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK;QAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;QAC3E,OAAO,IAAI,KAAK,iCAAiC,CAAC;IACpD,CAAC;CACF;AAtFD,sCAsFC;AAED;;;;;GAKG;AACH,MAAa,aAAa;IACxB;;;;;;OAMG;IACH,YAAY,aAAa;QACvB,IAAI,OAAO,aAAa,KAAK,UAAU;YACnC,aAAa,CAAC,WAAW,CAAC,IAAI,KAAK,wBAAwB,EAAE,CAAC;YAChE,IAAI,CAAC,cAAc,GAAG,aAAa,EAAE,CAAC;QACxC,CAAC;aAAM,IACL,CAAC,aAAa;YACd,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,aAAa,CAAC,EACjD,CAAC;YACD,MAAM,IAAI,SAAS,CACjB,kEAAkE,CACnE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACtC,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,KAAK,GAAG,EAAE,CAAA;QAEhB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAA;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QAChD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,cAAc,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,cAAc,GAAG,IAAI,CAAC;CACvB;AAnHD,sCAmHC;AAEY,QAAA,uBAAuB,GAAG,IAAI,qBAAS,CAAC,aAAa,CAAC,CAAA;AACtD,QAAA,uBAAuB,GAAG,IAAI,qBAAS,CAAC,aAAa,CAAC,CAAA"}