@pezkuwi/util 14.0.12 → 14.0.14

package/build/LICENSE

@@ -1,201 +0,0 @@
-                              Apache License
-                        Version 2.0, January 2004
-                    http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-  "License" shall mean the terms and conditions for use, reproduction,
-  and distribution as defined by Sections 1 through 9 of this document.
-
-  "Licensor" shall mean the copyright owner or entity authorized by
-  the copyright owner that is granting the License.
-
-  "Legal Entity" shall mean the union of the acting entity and all
-  other entities that control, are controlled by, or are under common
-  control with that entity. For the purposes of this definition,
-  "control" means (i) the power, direct or indirect, to cause the
-  direction or management of such entity, whether by contract or
-  otherwise, or (ii) ownership of fifty percent (50%) or more of the
-  outstanding shares, or (iii) beneficial ownership of such entity.
-
-  "You" (or "Your") shall mean an individual or Legal Entity
-  exercising permissions granted by this License.
-
-  "Source" form shall mean the preferred form for making modifications,
-  including but not limited to software source code, documentation
-  source, and configuration files.
-
-  "Object" form shall mean any form resulting from mechanical
-  transformation or translation of a Source form, including but
-  not limited to compiled object code, generated documentation,
-  and conversions to other media types.
-
-  "Work" shall mean the work of authorship, whether in Source or
-  Object form, made available under the License, as indicated by a
-  copyright notice that is included in or attached to the work
-  (an example is provided in the Appendix below).
-
-  "Derivative Works" shall mean any work, whether in Source or Object
-  form, that is based on (or derived from) the Work and for which the
-  editorial revisions, annotations, elaborations, or other modifications
-  represent, as a whole, an original work of authorship. For the purposes
-  of this License, Derivative Works shall not include works that remain
-  separable from, or merely link (or bind by name) to the interfaces of,
-  the Work and Derivative Works thereof.
-
-  "Contribution" shall mean any work of authorship, including
-  the original version of the Work and any modifications or additions
-  to that Work or Derivative Works thereof, that is intentionally
-  submitted to Licensor for inclusion in the Work by the copyright owner
-  or by an individual or Legal Entity authorized to submit on behalf of
-  the copyright owner. For the purposes of this definition, "submitted"
-  means any form of electronic, verbal, or written communication sent
-  to the Licensor or its representatives, including but not limited to
-  communication on electronic mailing lists, source code control systems,
-  and issue tracking systems that are managed by, or on behalf of, the
-  Licensor for the purpose of discussing and improving the Work, but
-  excluding communication that is conspicuously marked or otherwise
-  designated in writing by the copyright owner as "Not a Contribution."
-
-  "Contributor" shall mean Licensor and any individual or Legal Entity
-  on behalf of whom a Contribution has been received by Licensor and
-  subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-  this License, each Contributor hereby grants to You a perpetual,
-  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-  copyright license to reproduce, prepare Derivative Works of,
-  publicly display, publicly perform, sublicense, and distribute the
-  Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-  this License, each Contributor hereby grants to You a perpetual,
-  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-  (except as stated in this section) patent license to make, have made,
-  use, offer to sell, sell, import, and otherwise transfer the Work,
-  where such license applies only to those patent claims licensable
-  by such Contributor that are necessarily infringed by their
-  Contribution(s) alone or by combination of their Contribution(s)
-  with the Work to which such Contribution(s) was submitted. If You
-  institute patent litigation against any entity (including a
-  cross-claim or counterclaim in a lawsuit) alleging that the Work
-  or a Contribution incorporated within the Work constitutes direct
-  or contributory patent infringement, then any patent licenses
-  granted to You under this License for that Work shall terminate
-  as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-  Work or Derivative Works thereof in any medium, with or without
-  modifications, and in Source or Object form, provided that You
-  meet the following conditions:
-
-  (a) You must give any other recipients of the Work or
-      Derivative Works a copy of this License; and
-
-  (b) You must cause any modified files to carry prominent notices
-      stating that You changed the files; and
-
-  (c) You must retain, in the Source form of any Derivative Works
-      that You distribute, all copyright, patent, trademark, and
-      attribution notices from the Source form of the Work,
-      excluding those notices that do not pertain to any part of
-      the Derivative Works; and
-
-  (d) If the Work includes a "NOTICE" text file as part of its
-      distribution, then any Derivative Works that You distribute must
-      include a readable copy of the attribution notices contained
-      within such NOTICE file, excluding those notices that do not
-      pertain to any part of the Derivative Works, in at least one
-      of the following places: within a NOTICE text file distributed
-      as part of the Derivative Works; within the Source form or
-      documentation, if provided along with the Derivative Works; or,
-      within a display generated by the Derivative Works, if and
-      wherever such third-party notices normally appear. The contents
-      of the NOTICE file are for informational purposes only and
-      do not modify the License. You may add Your own attribution
-      notices within Derivative Works that You distribute, alongside
-      or as an addendum to the NOTICE text from the Work, provided
-      that such additional attribution notices cannot be construed
-      as modifying the License.
-
-  You may add Your own copyright statement to Your modifications and
-  may provide additional or different license terms and conditions
-  for use, reproduction, or distribution of Your modifications, or
-  for any such Derivative Works as a whole, provided Your use,
-  reproduction, and distribution of the Work otherwise complies with
-  the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-  any Contribution intentionally submitted for inclusion in the Work
-  by You to the Licensor shall be under the terms and conditions of
-  this License, without any additional terms or conditions.
-  Notwithstanding the above, nothing herein shall supersede or modify
-  the terms of any separate license agreement you may have executed
-  with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-  names, trademarks, service marks, or product names of the Licensor,
-  except as required for reasonable and customary use in describing the
-  origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-  agreed to in writing, Licensor provides the Work (and each
-  Contributor provides its Contributions) on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-  implied, including, without limitation, any warranties or conditions
-  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-  PARTICULAR PURPOSE. You are solely responsible for determining the
-  appropriateness of using or redistributing the Work and assume any
-  risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-  whether in tort (including negligence), contract, or otherwise,
-  unless required by applicable law (such as deliberate and grossly
-  negligent acts) or agreed to in writing, shall any Contributor be
-  liable to You for damages, including any direct, indirect, special,
-  incidental, or consequential damages of any character arising as a
-  result of this License or out of the use or inability to use the
-  Work (including but not limited to damages for loss of goodwill,
-  work stoppage, computer failure or malfunction, or any and all
-  other commercial damages or losses), even if such Contributor
-  has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-  the Work or Derivative Works thereof, You may choose to offer,
-  and charge a fee for, acceptance of support, warranty, indemnity,
-  or other liability obligations and/or rights consistent with this
-  License. However, in accepting such obligations, You may act only
-  on Your own behalf and on Your sole responsibility, not on behalf
-  of any other Contributor, and only if You agree to indemnify,
-  defend, and hold each Contributor harmless for any liability
-  incurred by, or claims asserted against, such Contributor by reason
-  of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-  To apply the Apache License to your work, attach the following
-  boilerplate notice, with the fields enclosed by brackets "[]"
-  replaced with your own identifying information. (Don't include
-  the brackets!)  The text should be enclosed in the appropriate
-  comment syntax for the file format. We also recommend that a
-  file or class name and description of purpose be included on the
-  same "printed page" as the copyright notice for easier
-  identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

package/build/README.md

@@ -1,17 +0,0 @@
-# @pezkuwi/util
-
-Various useful utility functions that are used across all projects in the [@pezkuwi](https://pezkuwi.js.org) namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.
-
-## Usage
-
-Installation -
-
-```
-yarn add @pezkuwi/util
-```
-
-Functions can be imported directly from the package, e.g.
-
-```js
-import { isHex } from '@pezkuwi/util';
-```

package/build/array/chunk.d.ts

@@ -1,15 +0,0 @@
-/**
- * @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/build/array/chunk.js

@@ -1,27 +0,0 @@
-/**
- * @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 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/build/array/filter.d.ts

@@ -1,16 +0,0 @@
-/**
- * @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/build/array/filter.js

@@ -1,19 +0,0 @@
-/**
- * @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 function arrayFilter(array, allowNulls = true) {
-    return array.filter((v) => v !== undefined &&
-        (allowNulls || v !== null));
-}

package/build/array/flatten.d.ts

@@ -1,15 +0,0 @@
-/**
- * @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/build/array/flatten.js

@@ -1,39 +0,0 @@
-/**
- * @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 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/build/array/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * @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/build/array/index.js

@@ -1,10 +0,0 @@
-/**
- * @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/build/array/range.d.ts

@@ -1,16 +0,0 @@
-/**
- * @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/build/array/range.js

@@ -1,25 +0,0 @@
-/**
- * @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 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/build/array/shuffle.d.ts

@@ -1,5 +0,0 @@
-/**
- * @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/build/array/shuffle.js

@@ -1,19 +0,0 @@
-/**
- * @name arrayShuffle
- * @description Shuffles the input array (unlike sort, this is not done in-place)
- */
-export 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/build/array/unzip.d.ts

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

package/build/array/unzip.js

@@ -1,13 +0,0 @@
-/**
- * @name arrayUnzip
- * @description Splits a single [K, V][] into [K[], V[]]
- */
-export 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/build/array/zip.d.ts

@@ -1,5 +0,0 @@
-/**
- * @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/build/array/zip.js

@@ -1,12 +0,0 @@
-/**
- * @name arrayZip
- * @description Combines 2 distinct key/value arrays into a single [K, V] array
- */
-export 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/build/assert.d.ts

@@ -1,29 +0,0 @@
-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/build/assert.js

@@ -1,39 +0,0 @@
-import { isFunction } from './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'
- * ```
- */
-export function assert(condition, message) {
-    if (!condition) {
-        throw new Error(isFunction(message)
-            ? message()
-            : message);
-    }
-}
-/**
- * @name assertReturn
- * @description Returns when the value is not undefined/null, otherwise throws assertion error
- */
-export function assertReturn(value, message) {
-    assert(value !== undefined && value !== null, message);
-    return value;
-}
-/**
- * @name assertUnreachable
- * @description An assertion helper that ensures all codepaths are followed
- */
-export function assertUnreachable(x) {
-    throw new Error(`This codepath should be unreachable. Unhandled input: ${x}`);
-}

package/build/bi/consts.d.ts

@@ -1,90 +0,0 @@
-/**
- * @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;