@koine/utils 2.0.0-beta.2 → 2.0.0-beta.21

package/Defer.d.ts

@@ -1,20 +1,6 @@
-/**
- * @category async
- */
 export type Deferred<T> = Promise<T> & {
     resolve: PromiseConstructor["resolve"];
     reject: PromiseConstructor["reject"];
 };
-/**
- * @category async
- * @see https://stackoverflow.com/a/37673534/1938970
- * @example
- *
- * ```ts
- * const deferred = Defer();
- * deferred.resolve();
- * deferred.then(handleSuccess, handleError);
- * ```
- */
 export declare function Defer<T>(): Deferred<T>;
 export default Defer;

package/Defer.js

@@ -1,19 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Defer = void 0;
-/**
- * @category async
- * @see https://stackoverflow.com/a/37673534/1938970
- * @example
- *
- * ```ts
- * const deferred = Defer();
- * deferred.resolve();
- * deferred.then(handleSuccess, handleError);
- * ```
- */
-function Defer() {
-    // @ts-expect-error nevermind
+export function Defer() {
     var self = this || {};
     var p = (self.promise = new Promise(function (resolve, reject) {
         self.resolve = resolve;
@@ -21,10 +6,6 @@ function Defer() {
     }));
     self.then = p.then.bind(p);
     self.catch = p.catch.bind(p);
-    // if (p.finally) {
-    //   self.finally = p.finally.bind(p);
-    // }
     return self;
 }
-exports.Defer = Defer;
-exports.default = Defer;
+export default Defer;

package/Emitter.d.ts

@@ -1,25 +1,7 @@
-/**
- * Emitter super simple class
- *
- * Events will be prefixed with the given `namespace` plus a `.` so:
- * `{namespace}.myevent`
- *
- * Adapted from https://github.com/developit/mitt
- *
- * Regarding typescript support @see:
- * - https://stackoverflow.com/q/53299743/1938970
- * - https://github.com/Microsoft/TypeScript/pull/26349
- */
 export declare function Emitter<EventMap extends {
     [key: string]: any;
 }>(namespace: string): {
-    /**
-     * Register an event handler for the given type.
-     */
     on<EventName extends keyof EventMap>(name: EventName, handler: (data?: EventMap[EventName] | undefined) => any): void;
-    /**
-     * Invoke all handlers for the given type.
-     */
     emit<EventName_1 extends keyof EventMap>(name: EventName_1, data?: EventMap[EventName_1] | undefined): void;
 };
 export default Emitter;

package/Emitter.js

@@ -1,24 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Emitter = void 0;
-/**
- * Emitter super simple class
- *
- * Events will be prefixed with the given `namespace` plus a `.` so:
- * `{namespace}.myevent`
- *
- * Adapted from https://github.com/developit/mitt
- *
- * Regarding typescript support @see:
- * - https://stackoverflow.com/q/53299743/1938970
- * - https://github.com/Microsoft/TypeScript/pull/26349
- */
-function Emitter(namespace) {
+export function Emitter(namespace) {
     var all = new Map();
     return {
-        /**
-         * Register an event handler for the given type.
-         */
         on: function (name, handler) {
             var handlers = all.get("".concat(namespace, ".").concat(String(name)));
             var added = handlers && handlers.push(handler);
@@ -26,9 +8,6 @@ function Emitter(namespace) {
                 all.set("".concat(namespace, ".").concat(String(name)), [handler]);
             }
         },
-        /**
-         * Invoke all handlers for the given type.
-         */
         emit: function (name, data) {
             (all.get("".concat(namespace, ".").concat(String(name))) || [])
                 .slice()
@@ -38,5 +17,4 @@ function Emitter(namespace) {
         },
     };
 }
-exports.Emitter = Emitter;
-exports.default = Emitter;
+export default Emitter;

package/accentSets.d.ts

@@ -1,16 +1,3 @@
-/**
- * First value is the `to`, second is `from`, from *which* chars do we translates *to*
- *
- * @category text
- */
 export type AccentsSet = [string, string];
-/**
- * Accent sets
- *
- * @category text
- * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
- * @see https://gist.github.com/eek/9c4887e80b3ede05c0e39fee4dce3747 for usage
- * of [normalize](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize)
- */
 export declare const accentsSets: AccentsSet[];
 export default accentsSets;

package/accentSets.js

@@ -1,15 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.accentsSets = void 0;
-/**
- * Accent sets
- *
- * @category text
- * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
- * @see https://gist.github.com/eek/9c4887e80b3ede05c0e39fee4dce3747 for usage
- * of [normalize](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize)
- */
-exports.accentsSets = [
+export var accentsSets = [
     ["a", "ÀÁÂÃÅÆĀĂĄẠẢẤẦẨẪẬẮẰẲẴẶ"],
     ["ae", "Ä"],
     ["c", "ÇĆĈČ"],
@@ -38,4 +27,4 @@ exports.accentsSets = [
     ["y", "ÝŶŸỲỴỶỸ"],
     ["z", "ŹŻŽ"],
 ];
-exports.default = exports.accentsSets;
+export default accentsSets;

package/addOrReplaceAtIdx.d.ts

@@ -1,5 +1,2 @@
-/**
- * @category array
- */
 export declare function addOrReplaceAtIdx<T>(list: T[], newItem: T, newIdx?: number): T[];
 export default addOrReplaceAtIdx;

package/addOrReplaceAtIdx.js

@@ -1,16 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addOrReplaceAtIdx = void 0;
-var tslib_1 = require("tslib");
-/**
- * @category array
- */
-function addOrReplaceAtIdx(list, newItem, newIdx) {
+import { __read, __spreadArray } from "tslib";
+export function addOrReplaceAtIdx(list, newItem, newIdx) {
     if (list.length === 0) {
         return [newItem];
     }
     if (typeof newIdx === "undefined" || list.length - 1 < newIdx) {
-        return tslib_1.__spreadArray(tslib_1.__spreadArray([], list, true), [newItem], false);
+        return __spreadArray(__spreadArray([], __read(list), false), [newItem], false);
     }
     return list.map(function (item, idx) {
         if (idx === newIdx) {
@@ -19,5 +13,4 @@ function addOrReplaceAtIdx(list, newItem, newIdx) {
         return item;
     });
 }
-exports.addOrReplaceAtIdx = addOrReplaceAtIdx;
-exports.default = addOrReplaceAtIdx;
+export default addOrReplaceAtIdx;

package/areEqual.d.ts

@@ -1,19 +1,4 @@
 type ComparablePrimitive = string | number | boolean;
 type Comparable = ComparablePrimitive | object | Record<string, ComparablePrimitive> | Array<ComparablePrimitive>;
-/**
- * A simple and quick deep equal objects utility. This is meant to be used
- * solely to deduplicate requests payload and perform comparison on JSON ready
- * objects made of primitives `string`, `number` and `boolean`s.
- *
- * It support nested `object`s and `array`s only.
- *
- * NB: `undefined` and `null` values do not count in the comparison as they are
- * usually meant to be ignored in JSON requestBody payloads.
- *
- * According to very rudimentary tests this function takes on average between
- * 0.15 ms and 2ms to compare two averaged sizes requet body payloads.
- *
- * @category objects
- */
 export declare function areEqual(a: Comparable, b?: Comparable): boolean;
 export default areEqual;

package/areEqual.js

@@ -1,8 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.areEqual = void 0;
-var isArray_1 = require("./isArray");
-var isObject_1 = require("./isObject");
+import { __values } from "tslib";
+import { isArray } from "./isArray.js";
+import { isObject } from "./isObject.js";
 function areEqualArrays(a, b) {
     if (!b)
         return false;
@@ -17,6 +15,7 @@ function areEqualArrays(a, b) {
     return true;
 }
 function areEqualObjects(a, b) {
+    var e_1, _a;
     if (!b)
         return false;
     var aKeys = Object.keys(a);
@@ -24,58 +23,44 @@ function areEqualObjects(a, b) {
     if (aKeys.length !== bKeys.length) {
         return false;
     }
-    for (var _i = 0, aKeys_1 = aKeys; _i < aKeys_1.length; _i++) {
-        var _key = aKeys_1[_i];
-        var key = _key;
-        var aValue = a[key];
-        var bValue = b[key];
-        if (!areEqual(aValue, bValue)) {
-            return false;
+    try {
+        for (var aKeys_1 = __values(aKeys), aKeys_1_1 = aKeys_1.next(); !aKeys_1_1.done; aKeys_1_1 = aKeys_1.next()) {
+            var _key = aKeys_1_1.value;
+            var key = _key;
+            var aValue = a[key];
+            var bValue = b[key];
+            if (!areEqual(aValue, bValue)) {
+                return false;
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (aKeys_1_1 && !aKeys_1_1.done && (_a = aKeys_1.return)) _a.call(aKeys_1);
         }
+        finally { if (e_1) throw e_1.error; }
     }
     return true;
 }
-/**
- * A simple and quick deep equal objects utility. This is meant to be used
- * solely to deduplicate requests payload and perform comparison on JSON ready
- * objects made of primitives `string`, `number` and `boolean`s.
- *
- * It support nested `object`s and `array`s only.
- *
- * NB: `undefined` and `null` values do not count in the comparison as they are
- * usually meant to be ignored in JSON requestBody payloads.
- *
- * According to very rudimentary tests this function takes on average between
- * 0.15 ms and 2ms to compare two averaged sizes requet body payloads.
- *
- * @category objects
- */
-function areEqual(a, b) {
+export function areEqual(a, b) {
     if (!a && !b) {
-        // console.log(`areEqual took ${performance.now() - t0} ms`);
         return true;
     }
-    // const t0 = performance.now();
     if (!b && a !== b) {
-        // console.log(`areEqual took ${performance.now() - t0} ms`);
         return false;
     }
-    var areObjects = (0, isObject_1.isObject)(a) && (0, isObject_1.isObject)(b);
+    var areObjects = isObject(a) && isObject(b);
     if (areObjects && !areEqualObjects(a, b)) {
-        // console.log(`areEqual took ${performance.now() - t0} ms`);
         return false;
     }
-    var areArrays = (0, isArray_1.isArray)(a) && (0, isArray_1.isArray)(b);
+    var areArrays = isArray(a) && isArray(b);
     if (areArrays && !areEqualArrays(a, b)) {
-        // console.log(`areEqual took ${performance.now() - t0} ms`);
         return false;
     }
     if (!areObjects && !areArrays && a !== b) {
-        // console.log(`areEqual took ${performance.now() - t0} ms`);
         return false;
     }
-    // console.log(`areEqual took ${performance.now() - t0} ms`);
     return true;
 }
-exports.areEqual = areEqual;
-exports.default = areEqual;
+export default areEqual;

package/arrayOfAll.d.ts

@@ -1,28 +1,2 @@
-/**
- * Ensure an array contains all desired values
- *
- * @category array
- * @borrows [SO comment by `CertainPerformance`](https://stackoverflow.com/a/60132060/1938970)
- *
- * @usage
- *
- * ```
- * type Fruit = "pear" | "apple" | "orange";
- *
- * const arrayOfAllFruits = arrayOfAll<Fruit>();
- *
- * const allFruits = arrayOfAllFruits([
- *  "pear",
- *  "apple",
- *  "orange"
- * ]); // ts compiler ok
- *
- * const allFruits = arrayOfAllFruits([
- *  "pear",
- *  "apple",
- * ]); // ts compiler fails
- * ```
- *
- */
 export declare const arrayOfAll: <T>() => <U extends T[]>(array: U & ([T] extends [U[number]] ? unknown : "Invalid")) => U & ([T] extends [U[number]] ? unknown : "Invalid");
 export default arrayOfAll;

package/arrayOfAll.js

@@ -1,36 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayOfAll = void 0;
-/**
- * Ensure an array contains all desired values
- *
- * @category array
- * @borrows [SO comment by `CertainPerformance`](https://stackoverflow.com/a/60132060/1938970)
- *
- * @usage
- *
- * ```
- * type Fruit = "pear" | "apple" | "orange";
- *
- * const arrayOfAllFruits = arrayOfAll<Fruit>();
- *
- * const allFruits = arrayOfAllFruits([
- *  "pear",
- *  "apple",
- *  "orange"
- * ]); // ts compiler ok
- *
- * const allFruits = arrayOfAllFruits([
- *  "pear",
- *  "apple",
- * ]); // ts compiler fails
- * ```
- *
- */
-var arrayOfAll = function () {
+export var arrayOfAll = function () {
     return function (array) {
         return array;
     };
 };
-exports.arrayOfAll = arrayOfAll;
-exports.default = exports.arrayOfAll;
+export default arrayOfAll;

package/arraySum.d.ts

@@ -1,7 +1,2 @@
-/**
- * Sum array of numbers
- *
- * @category array | math
- */
 export declare const arraySum: (numbers: number[]) => number;
 export default arraySum;

package/arraySum.js

@@ -1,13 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.arraySum = void 0;
-/**
- * Sum array of numbers
- *
- * @category array | math
- */
-var arraySum = function (numbers) {
+export var arraySum = function (numbers) {
     return numbers.reduce(function (sum, current) { return sum + current; }, 0);
 };
-exports.arraySum = arraySum;
-exports.default = exports.arraySum;
+export default arraySum;

package/arrayToLookup.d.ts

@@ -1,7 +1,2 @@
-/**
- * Maps a simple flat array to a lookup dictionary object
- *
- * @category array
- */
 export declare function arrayToLookup<T extends string | number | symbol>(array?: T[]): Record<T, 1>;
 export default arrayToLookup;

package/arrayToLookup.js

@@ -1,17 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayToLookup = void 0;
-/**
- * Maps a simple flat array to a lookup dictionary object
- *
- * @category array
- */
-function arrayToLookup(array) {
+export function arrayToLookup(array) {
     if (array === void 0) { array = []; }
     return array.reduce(function (obj, item) {
         obj[item] = 1;
         return obj;
     }, {});
 }
-exports.arrayToLookup = arrayToLookup;
-exports.default = arrayToLookup;
+export default arrayToLookup;

package/arrayUniqueByProperties.d.ts

@@ -0,0 +1,2 @@
+export declare const arrayUniqueByProperties: <T extends any[]>(array: T, keys: (keyof T[number])[]) => T;
+export default arrayUniqueByProperties;

package/arrayUniqueByProperties.js

@@ -0,0 +1,8 @@
+export var arrayUniqueByProperties = function (array, keys) {
+    return array.filter(function (item, idx, arr) {
+        return arr.findIndex(function (itemWith) {
+            return keys.every(function (k) { return itemWith[k] === item[k]; });
+        }) === idx;
+    });
+};
+export default arrayUniqueByProperties;

package/buildUrlQueryString.d.ts

@@ -1,12 +1,3 @@
-import { type AnyQueryParams } from "./location";
-/**
- * Get clean query string for URL
- *
- * It returns the query string **with** the initial `?`
- *
- * TODO: at some point replace with `URLSearchParams`, @see [caniuse](https://caniuse.com/?search=URLSearchParams)
- *
- * @category location
- */
+import { type AnyQueryParams } from "./location.js";
 export declare function buildUrlQueryString<T extends AnyQueryParams>(params: T): string;
 export default buildUrlQueryString;

package/buildUrlQueryString.js

@@ -1,36 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildUrlQueryString = void 0;
-var tslib_1 = require("tslib");
-var isNull_1 = tslib_1.__importDefault(require("./isNull"));
-var isUndefined_1 = tslib_1.__importDefault(require("./isUndefined"));
-var isArray_1 = tslib_1.__importDefault(require("./isArray"));
-/**
- * Get clean query string for URL
- *
- * It returns the query string **with** the initial `?`
- *
- * TODO: at some point replace with `URLSearchParams`, @see [caniuse](https://caniuse.com/?search=URLSearchParams)
- *
- * @category location
- */
-function buildUrlQueryString(params) {
+import isArray from "./isArray.js";
+import isNull from "./isNull.js";
+import isUndefined from "./isUndefined.js";
+export function buildUrlQueryString(params) {
     var output = "";
     if (!params)
         return output;
     for (var key in params) {
         var value = params[key];
-        if ((0, isArray_1.default)(value)) {
+        if (isArray(value)) {
             for (var i = 0; i < value.length; i++) {
                 output += "".concat(key, "=").concat(encodeURIComponent(value[i] + ""), "&");
             }
         }
-        else if (!(0, isNull_1.default)(value) && !(0, isUndefined_1.default)(value)) {
+        else if (!isNull(value) && !isUndefined(value)) {
             output += "".concat(key, "=").concat(encodeURIComponent(value + ""), "&");
         }
     }
-    // removes the last &
     return output ? "?".concat(output.replace(/&+$/, "")) : "";
 }
-exports.buildUrlQueryString = buildUrlQueryString;
-exports.default = buildUrlQueryString;
+export default buildUrlQueryString;

package/capitalize.d.ts

@@ -1,8 +1,2 @@
-/**
- * Capitalize first letter of the given string.
- *
- * @category text
- * @see https://stackoverflow.com/a/11409944/1938970
- */
 export declare function capitalize<T extends string>(string?: null | T): Capitalize<T>;
 export default capitalize;

package/capitalize.js

@@ -1,16 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.capitalize = void 0;
-/**
- * Capitalize first letter of the given string.
- *
- * @category text
- * @see https://stackoverflow.com/a/11409944/1938970
- */
-function capitalize(string) {
+export function capitalize(string) {
     var ensuredString = string || "";
     return (ensuredString.charAt(0).toUpperCase() +
         ensuredString.slice(1));
 }
-exports.capitalize = capitalize;
-exports.default = capitalize;
+export default capitalize;

package/changeUrlPath.d.ts

@@ -1,10 +1,2 @@
-/**
- * Change URL path, ensures initial and ending slashes and normalise eventual
- * consecutive slashes, it uses `history`.
- *
- * @category location
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- * @returns {string} The new cleaned pathname
- */
 export declare function changeUrlPath(pathname: string, state?: object, replace?: boolean): string;
 export default changeUrlPath;

package/changeUrlPath.js

@@ -1,23 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.changeUrlPath = void 0;
-var tslib_1 = require("tslib");
-var isBrowser_1 = tslib_1.__importDefault(require("./isBrowser"));
-var normaliseUrlPathname_1 = tslib_1.__importDefault(require("./normaliseUrlPathname"));
-/**
- * Change URL path, ensures initial and ending slashes and normalise eventual
- * consecutive slashes, it uses `history`.
- *
- * @category location
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- * @returns {string} The new cleaned pathname
- */
-function changeUrlPath(pathname, state, replace) {
-    var path = (0, normaliseUrlPathname_1.default)("/".concat(pathname, "/"));
-    if (isBrowser_1.default) {
+import isBrowser from "./isBrowser.js";
+import normaliseUrlPathname from "./normaliseUrlPathname.js";
+export function changeUrlPath(pathname, state, replace) {
+    var path = normaliseUrlPathname("/".concat(pathname, "/"));
+    if (isBrowser) {
         history[replace ? "replaceState" : "pushState"](state, "", path);
     }
     return path;
 }
-exports.changeUrlPath = changeUrlPath;
-exports.default = changeUrlPath;
+export default changeUrlPath;

package/chunkByChunks.d.ts

@@ -1,7 +1,2 @@
-/**
- * TODO: untested
- * @category array
- * @see https://stackoverflow.com/a/8189268/1938970
- */
 export declare function chunkByChunks<T>(arr: T[], nrOfChunks: number, balanced?: boolean): T[][];
 export default chunkByChunks;

package/chunkByChunks.js

@@ -1,12 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.chunkByChunks = void 0;
-/**
- * TODO: untested
- * @category array
- * @see https://stackoverflow.com/a/8189268/1938970
- */
-function chunkByChunks(arr, nrOfChunks, balanced) {
+export function chunkByChunks(arr, nrOfChunks, balanced) {
     if (nrOfChunks < 2)
         return [arr];
     var len = arr.length;
@@ -37,5 +29,4 @@ function chunkByChunks(arr, nrOfChunks, balanced) {
     }
     return output;
 }
-exports.chunkByChunks = chunkByChunks;
-exports.default = chunkByChunks;
+export default chunkByChunks;

package/chunkBySize.d.ts

@@ -1,6 +1,2 @@
-/**
- * @category array
- * @see https://stackoverflow.com/a/40682136/1938970
- */
 export declare function chunkBySize<T>(arr: T[], size: number): T[][];
 export default chunkBySize;

package/chunkBySize.js

@@ -1,16 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.chunkBySize = void 0;
-/**
- * @category array
- * @see https://stackoverflow.com/a/40682136/1938970
- */
-function chunkBySize(arr, size) {
+export function chunkBySize(arr, size) {
     var output = [];
     for (var i = 0; i < arr.length; i += size) {
         output.push(arr.slice(i, i + size));
     }
     return output;
 }
-exports.chunkBySize = chunkBySize;
-exports.default = chunkBySize;
+export default chunkBySize;

package/cjs/Defer.d.ts

@@ -0,0 +1,6 @@
+export type Deferred<T> = Promise<T> & {
+    resolve: PromiseConstructor["resolve"];
+    reject: PromiseConstructor["reject"];
+};
+export declare function Defer<T>(): Deferred<T>;
+export default Defer;