@pezkuwi/util 14.0.10 → 14.0.11

package/bundle.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @summary Utility methods for this package are split into groups
+ */
+export { packageInfo } from './packageInfo.js';
+export * from './array/index.js';
+export * from './assert.js';
+export * from './bi/index.js';
+export * from './bn/index.js';
+export * from './buffer/index.js';
+export * from './compact/index.js';
+export * from './detectPackage.js';
+export * from './extractTime.js';
+export * from './float/index.js';
+export * from './format/index.js';
+export * from './has.js';
+export * from './hex/index.js';
+export * from './is/index.js';
+export * from './lazy.js';
+export * from './logger.js';
+export * from './memoize.js';
+export * from './nextTick.js';
+export * from './noop.js';
+export * from './number/index.js';
+export * from './object/index.js';
+export * from './promisify.js';
+export * from './string/index.js';
+export * from './stringify.js';
+export * from './u8a/index.js';

package/bundle.js

@@ -0,0 +1,28 @@
+/**
+ * @summary Utility methods for this package are split into groups
+ */
+export { packageInfo } from './packageInfo.js';
+export * from './array/index.js';
+export * from './assert.js';
+export * from './bi/index.js';
+export * from './bn/index.js';
+export * from './buffer/index.js';
+export * from './compact/index.js';
+export * from './detectPackage.js';
+export * from './extractTime.js';
+export * from './float/index.js';
+export * from './format/index.js';
+export * from './has.js';
+export * from './hex/index.js';
+export * from './is/index.js';
+export * from './lazy.js';
+export * from './logger.js';
+export * from './memoize.js';
+export * from './nextTick.js';
+export * from './noop.js';
+export * from './number/index.js';
+export * from './object/index.js';
+export * from './promisify.js';
+export * from './string/index.js';
+export * from './stringify.js';
+export * from './u8a/index.js';

package/cjs/array/chunk.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @name arrayChunk
+ * @summary Split T[] into T[][] based on the defind size
+ * @description
+ * Returns a set ao arrays based on the chunksize
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayChunk } from '@pezkuwi/util';
+ *
+ * arrayChunk([1, 2, 3, 4, 5]); // [[1, 2], [3, 4], [5]]
+ * ```
+ */
+export declare function arrayChunk<T>(array: T[], chunkSize: number): T[][];

package/cjs/array/chunk.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayChunk = arrayChunk;
+/**
+ * @name arrayChunk
+ * @summary Split T[] into T[][] based on the defind size
+ * @description
+ * Returns a set ao arrays based on the chunksize
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayChunk } from '@pezkuwi/util';
+ *
+ * arrayChunk([1, 2, 3, 4, 5]); // [[1, 2], [3, 4], [5]]
+ * ```
+ */
+function arrayChunk(array, chunkSize) {
+    const outputSize = Math.ceil(array.length / chunkSize);
+    // shortcut for the single-split case
+    if (outputSize === 1) {
+        return [array];
+    }
+    const output = Array(outputSize);
+    for (let i = 0; i < outputSize; i++) {
+        const offset = i * chunkSize;
+        output[i] = array.slice(offset, offset + chunkSize);
+    }
+    return output;
+}

package/cjs/array/filter.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @name arrayFilter
+ * @summary Filters undefined and (optionally) null values from an array
+ * @description
+ * Returns a new array with all `undefined` values removed. Optionally, when `allowNulls = false`, it removes the `null` values as well
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayFilter } from '@pezkuwi/util';
+ *
+ * arrayFilter([0, void 0, true, null, false, '']); // [0, true, null, false, '']
+ * arrayFilter([0, void 0, true, null, false, ''], false); // [0, true, false, '']
+ * ```
+ */
+export declare function arrayFilter<T = unknown>(array: readonly (T | null | undefined)[], allowNulls?: boolean): T[];

package/cjs/array/filter.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayFilter = arrayFilter;
+/**
+ * @name arrayFilter
+ * @summary Filters undefined and (optionally) null values from an array
+ * @description
+ * Returns a new array with all `undefined` values removed. Optionally, when `allowNulls = false`, it removes the `null` values as well
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayFilter } from '@pezkuwi/util';
+ *
+ * arrayFilter([0, void 0, true, null, false, '']); // [0, true, null, false, '']
+ * arrayFilter([0, void 0, true, null, false, ''], false); // [0, true, false, '']
+ * ```
+ */
+function arrayFilter(array, allowNulls = true) {
+    return array.filter((v) => v !== undefined &&
+        (allowNulls || v !== null));
+}

package/cjs/array/flatten.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @name arrayFlatten
+ * @summary Merge T[][] into T[]
+ * @description
+ * Returns a new array with all arrays merged into one
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayFlatten } from '@pezkuwi/util';
+ *
+ * arrayFlatten([[1, 2], [3, 4], [5]]); // [1, 2, 3, 4, 5]
+ * ```
+ */
+export declare function arrayFlatten<T>(arrays: readonly T[][]): T[];

package/cjs/array/flatten.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayFlatten = arrayFlatten;
+/**
+ * @name arrayFlatten
+ * @summary Merge T[][] into T[]
+ * @description
+ * Returns a new array with all arrays merged into one
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayFlatten } from '@pezkuwi/util';
+ *
+ * arrayFlatten([[1, 2], [3, 4], [5]]); // [1, 2, 3, 4, 5]
+ * ```
+ */
+function arrayFlatten(arrays) {
+    const num = arrays.length;
+    // shortcuts for the empty & single-entry case
+    if (num === 0) {
+        return [];
+    }
+    else if (num === 1) {
+        return arrays[0];
+    }
+    // pre-allocate based on the combined size
+    let size = 0;
+    for (let i = 0; i < num; i++) {
+        size += arrays[i].length;
+    }
+    const output = new Array(size);
+    let i = -1;
+    for (let j = 0; j < num; j++) {
+        const a = arrays[j];
+        // instead of pushing, we just set the entries
+        for (let e = 0, count = a.length; e < count; e++) {
+            output[++i] = a[e];
+        }
+    }
+    return output;
+}

package/cjs/array/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @summary Utility methods that operates on arrays
+ */
+export { arrayChunk } from './chunk.js';
+export { arrayFilter } from './filter.js';
+export { arrayFlatten } from './flatten.js';
+export { arrayRange } from './range.js';
+export { arrayShuffle } from './shuffle.js';
+export { arrayUnzip } from './unzip.js';
+export { arrayZip } from './zip.js';

package/cjs/array/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayZip = exports.arrayUnzip = exports.arrayShuffle = exports.arrayRange = exports.arrayFlatten = exports.arrayFilter = exports.arrayChunk = void 0;
+/**
+ * @summary Utility methods that operates on arrays
+ */
+var chunk_js_1 = require("./chunk.js");
+Object.defineProperty(exports, "arrayChunk", { enumerable: true, get: function () { return chunk_js_1.arrayChunk; } });
+var filter_js_1 = require("./filter.js");
+Object.defineProperty(exports, "arrayFilter", { enumerable: true, get: function () { return filter_js_1.arrayFilter; } });
+var flatten_js_1 = require("./flatten.js");
+Object.defineProperty(exports, "arrayFlatten", { enumerable: true, get: function () { return flatten_js_1.arrayFlatten; } });
+var range_js_1 = require("./range.js");
+Object.defineProperty(exports, "arrayRange", { enumerable: true, get: function () { return range_js_1.arrayRange; } });
+var shuffle_js_1 = require("./shuffle.js");
+Object.defineProperty(exports, "arrayShuffle", { enumerable: true, get: function () { return shuffle_js_1.arrayShuffle; } });
+var unzip_js_1 = require("./unzip.js");
+Object.defineProperty(exports, "arrayUnzip", { enumerable: true, get: function () { return unzip_js_1.arrayUnzip; } });
+var zip_js_1 = require("./zip.js");
+Object.defineProperty(exports, "arrayZip", { enumerable: true, get: function () { return zip_js_1.arrayZip; } });

package/cjs/array/range.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @name arrayRange
+ * @summary Returns a range of numbers ith the size and the specified offset
+ * @description
+ * Returns a new array of numbers with the specific size. Optionally, when `startAt`, is provided, it generates the range to start at a specific value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayRange } from '@pezkuwi/util';
+ *
+ * arrayRange(5); // [0, 1, 2, 3, 4]
+ * arrayRange(3, 5); // [5, 6, 7]
+ * ```
+ */
+export declare function arrayRange(size: number, startAt?: number): number[];

package/cjs/array/range.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayRange = arrayRange;
+/**
+ * @name arrayRange
+ * @summary Returns a range of numbers ith the size and the specified offset
+ * @description
+ * Returns a new array of numbers with the specific size. Optionally, when `startAt`, is provided, it generates the range to start at a specific value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { arrayRange } from '@pezkuwi/util';
+ *
+ * arrayRange(5); // [0, 1, 2, 3, 4]
+ * arrayRange(3, 5); // [5, 6, 7]
+ * ```
+ */
+function arrayRange(size, startAt = 0) {
+    if (size <= 0) {
+        throw new Error('Expected non-zero, positive number as a range size');
+    }
+    const result = new Array(size);
+    for (let i = 0; i < size; i++) {
+        result[i] = i + startAt;
+    }
+    return result;
+}

package/cjs/array/shuffle.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @name arrayShuffle
+ * @description Shuffles the input array (unlike sort, this is not done in-place)
+ */
+export declare function arrayShuffle<T>(input: readonly T[]): T[];

package/cjs/array/shuffle.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayShuffle = arrayShuffle;
+/**
+ * @name arrayShuffle
+ * @description Shuffles the input array (unlike sort, this is not done in-place)
+ */
+function arrayShuffle(input) {
+    const result = input.slice();
+    let curr = result.length;
+    // noop for the single entry
+    if (curr === 1) {
+        return result;
+    }
+    while (curr !== 0) {
+        // ~~ is more performant than Math.floor
+        const rand = ~~(Math.random() * curr);
+        curr--;
+        [result[curr], result[rand]] = [result[rand], result[curr]];
+    }
+    return result;
+}

package/cjs/array/unzip.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @name arrayUnzip
+ * @description Splits a single [K, V][] into [K[], V[]]
+ */
+export declare function arrayUnzip<K, V>(entries: readonly [K, V][]): [K[], V[]];

package/cjs/array/unzip.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayUnzip = arrayUnzip;
+/**
+ * @name arrayUnzip
+ * @description Splits a single [K, V][] into [K[], V[]]
+ */
+function arrayUnzip(entries) {
+    const count = entries.length;
+    const keys = new Array(count);
+    const values = new Array(count);
+    for (let i = 0; i < count; i++) {
+        [keys[i], values[i]] = entries[i];
+    }
+    return [keys, values];
+}

package/cjs/array/zip.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @name arrayZip
+ * @description Combines 2 distinct key/value arrays into a single [K, V] array
+ */
+export declare function arrayZip<K, V>(keys: readonly K[], values: readonly V[]): [K, V][];

package/cjs/array/zip.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayZip = arrayZip;
+/**
+ * @name arrayZip
+ * @description Combines 2 distinct key/value arrays into a single [K, V] array
+ */
+function arrayZip(keys, values) {
+    const count = keys.length;
+    const result = new Array(count);
+    for (let i = 0; i < count; i++) {
+        result[i] = [keys[i], values[i]];
+    }
+    return result;
+}

package/cjs/assert.d.ts

@@ -0,0 +1,29 @@
+type MessageFn = () => string;
+/**
+ * @name assert
+ * @summary Checks for a valid test, if not Error is thrown.
+ * @description
+ * Checks that `test` is a truthy value. If value is falsy (`null`, `undefined`, `false`, ...), it throws an Error with the supplied `message`. When `test` passes, `true` is returned.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const { assert } from '@pezkuwi/util';
+ *
+ * assert(true, 'True should be true'); // passes
+ * assert(false, 'False should not be true'); // Error thrown
+ * assert(false, () => 'message'); // Error with 'message'
+ * ```
+ */
+export declare function assert(condition: unknown, message: string | MessageFn): asserts condition;
+/**
+ * @name assertReturn
+ * @description Returns when the value is not undefined/null, otherwise throws assertion error
+ */
+export declare function assertReturn<T>(value: T | undefined | null, message: string | MessageFn): T;
+/**
+ * @name assertUnreachable
+ * @description An assertion helper that ensures all codepaths are followed
+ */
+export declare function assertUnreachable(x: never): never;
+export {};

package/cjs/assert.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assert = assert;
+exports.assertReturn = assertReturn;
+exports.assertUnreachable = assertUnreachable;
+const function_js_1 = require("./is/function.js");
+/**
+ * @name assert
+ * @summary Checks for a valid test, if not Error is thrown.
+ * @description
+ * Checks that `test` is a truthy value. If value is falsy (`null`, `undefined`, `false`, ...), it throws an Error with the supplied `message`. When `test` passes, `true` is returned.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const { assert } from '@pezkuwi/util';
+ *
+ * assert(true, 'True should be true'); // passes
+ * assert(false, 'False should not be true'); // Error thrown
+ * assert(false, () => 'message'); // Error with 'message'
+ * ```
+ */
+function assert(condition, message) {
+    if (!condition) {
+        throw new Error((0, function_js_1.isFunction)(message)
+            ? message()
+            : message);
+    }
+}
+/**
+ * @name assertReturn
+ * @description Returns when the value is not undefined/null, otherwise throws assertion error
+ */
+function assertReturn(value, message) {
+    assert(value !== undefined && value !== null, message);
+    return value;
+}
+/**
+ * @name assertUnreachable
+ * @description An assertion helper that ensures all codepaths are followed
+ */
+function assertUnreachable(x) {
+    throw new Error(`This codepath should be unreachable. Unhandled input: ${x}`);
+}

package/cjs/bi/consts.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @name _0n
+ * @summary BigInt constant for 0.
+ */
+export declare const _0n: bigint;
+/**
+ * @name _1n
+ * @summary BigInt constant for 1.
+ */
+export declare const _1n: bigint;
+/**
+ * @name _2n
+ * @summary BigInt constant for 2.
+ */
+export declare const _2n: bigint;
+/**
+ * @name _3n
+ * @summary BigInt constant for 3.
+ */
+export declare const _3n: bigint;
+/**
+ * @name _4n
+ * @summary BigInt constant for 4.
+ */
+export declare const _4n: bigint;
+/**
+ * @name _5n
+ * @summary BigInt constant for 5.
+ */
+export declare const _5n: bigint;
+/**
+ * @name _6n
+ * @summary BigInt constant for 6.
+ */
+export declare const _6n: bigint;
+/**
+ * @name _7n
+ * @summary BigInt constant for 7.
+ */
+export declare const _7n: bigint;
+/**
+ * @name _8n
+ * @summary BigInt constant for 8.
+ */
+export declare const _8n: bigint;
+/**
+ * @name _9n
+ * @summary BigInt constant for 9.
+ */
+export declare const _9n: bigint;
+/**
+ * @name _10n
+ * @summary BigInt constant for 10.
+ */
+export declare const _10n: bigint;
+/**
+ * @name _100n
+ * @summary BigInt constant for 100.
+ */
+export declare const _100n: bigint;
+/**
+ * @name _1000n
+ * @summary BigInt constant for 1000.
+ */
+export declare const _1000n: bigint;
+/**
+ * @name _1Mn
+ * @summary BigInt constant for 1,000,000 (million).
+ */
+export declare const _1Mn: bigint;
+/**
+* @name _1Bn
+* @summary BigInt constant for 1,000,000,000 (billion).
+*/
+export declare const _1Bn: bigint;
+/**
+* @name _1Qn
+* @summary BigInt constant for 1,000,000,000,000,000,000 (quitillion).
+*/
+export declare const _1Qn: bigint;
+/**
+* @name _2pow53n
+* @summary BigInt constant for MAX_SAFE_INTEGER
+*/
+export declare const _2pow53n: bigint;
+/**
+ * @name _sqrt2pow53n
+ * @summary BigInt constant for Math.sqrt(MAX_SAFE_INTEGER)
+ */
+export declare const _sqrt2pow53n: bigint;

package/cjs/bi/consts.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._sqrt2pow53n = exports._2pow53n = exports._1Qn = exports._1Bn = exports._1Mn = exports._1000n = exports._100n = exports._10n = exports._9n = exports._8n = exports._7n = exports._6n = exports._5n = exports._4n = exports._3n = exports._2n = exports._1n = exports._0n = void 0;
+const x_bigint_1 = require("@pezkuwi/x-bigint");
+/**
+ * @name _0n
+ * @summary BigInt constant for 0.
+ */
+exports._0n = (0, x_bigint_1.BigInt)(0);
+/**
+ * @name _1n
+ * @summary BigInt constant for 1.
+ */
+exports._1n = (0, x_bigint_1.BigInt)(1);
+/**
+ * @name _2n
+ * @summary BigInt constant for 2.
+ */
+exports._2n = (0, x_bigint_1.BigInt)(2);
+/**
+ * @name _3n
+ * @summary BigInt constant for 3.
+ */
+exports._3n = (0, x_bigint_1.BigInt)(3);
+/**
+ * @name _4n
+ * @summary BigInt constant for 4.
+ */
+exports._4n = (0, x_bigint_1.BigInt)(4);
+/**
+ * @name _5n
+ * @summary BigInt constant for 5.
+ */
+exports._5n = (0, x_bigint_1.BigInt)(5);
+/**
+ * @name _6n
+ * @summary BigInt constant for 6.
+ */
+exports._6n = (0, x_bigint_1.BigInt)(6);
+/**
+ * @name _7n
+ * @summary BigInt constant for 7.
+ */
+exports._7n = (0, x_bigint_1.BigInt)(7);
+/**
+ * @name _8n
+ * @summary BigInt constant for 8.
+ */
+exports._8n = (0, x_bigint_1.BigInt)(8);
+/**
+ * @name _9n
+ * @summary BigInt constant for 9.
+ */
+exports._9n = (0, x_bigint_1.BigInt)(9);
+/**
+ * @name _10n
+ * @summary BigInt constant for 10.
+ */
+exports._10n = (0, x_bigint_1.BigInt)(10);
+/**
+ * @name _100n
+ * @summary BigInt constant for 100.
+ */
+exports._100n = (0, x_bigint_1.BigInt)(100);
+/**
+ * @name _1000n
+ * @summary BigInt constant for 1000.
+ */
+exports._1000n = (0, x_bigint_1.BigInt)(1_000);
+/**
+ * @name _1Mn
+ * @summary BigInt constant for 1,000,000 (million).
+ */
+exports._1Mn = (0, x_bigint_1.BigInt)(1_000_000);
+/**
+* @name _1Bn
+* @summary BigInt constant for 1,000,000,000 (billion).
+*/
+exports._1Bn = (0, x_bigint_1.BigInt)(1_000_000_000);
+/**
+* @name _1Qn
+* @summary BigInt constant for 1,000,000,000,000,000,000 (quitillion).
+*/
+exports._1Qn = exports._1Bn * exports._1Bn;
+/**
+* @name _2pow53n
+* @summary BigInt constant for MAX_SAFE_INTEGER
+*/
+exports._2pow53n = (0, x_bigint_1.BigInt)(Number.MAX_SAFE_INTEGER);
+/**
+ * @name _sqrt2pow53n
+ * @summary BigInt constant for Math.sqrt(MAX_SAFE_INTEGER)
+ */
+exports._sqrt2pow53n = (0, x_bigint_1.BigInt)(94906265);

package/cjs/bi/helpers.d.ts

@@ -0,0 +1,2 @@
+/** @internal */
+export declare function createCmp<T>(cmp: (a: T, b: T) => boolean): (...items: T[]) => T;

package/cjs/bi/helpers.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCmp = createCmp;
+/** @internal */
+function createCmp(cmp) {
+    return (...items) => {
+        const count = items.length;
+        if (count === 0) {
+            throw new Error('Must provide one or more arguments');
+        }
+        let result = items[0];
+        for (let i = 1; i < count; i++) {
+            if (cmp(items[i], result)) {
+                result = items[i];
+            }
+        }
+        return result;
+    };
+}

package/cjs/bi/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @summary Utility methods to convert to and from `bigint` objects
+ */
+export { nMax, nMin } from './min.js';
+export { nSqrt } from './sqrt.js';
+export { nToBigInt } from './toBigInt.js';
+export { nToHex } from './toHex.js';
+export { nToU8a } from './toU8a.js';
+export * from './consts.js';