@koine/utils 2.0.0-beta.1 → 2.0.0-beta.11

package/Defer.mjs

@@ -1,4 +1,6 @@
 /**
+ * @category async
+ */ /**
  * @category async
  * @see https://stackoverflow.com/a/37673534/1938970
  * @example
@@ -8,14 +10,13 @@
  * deferred.resolve();
  * deferred.then(handleSuccess, handleError);
  * ```
- */
-export function Defer() {
+ */ export function Defer() /* : PromiseConstructor */ {
     // @ts-expect-error nevermind
-    var self = this || {};
-    var p = (self.promise = new Promise(function (resolve, reject) {
+    const self = this || {};
+    const p = self.promise = new Promise((resolve, reject)=>{
         self.resolve = resolve;
         self.reject = reject;
-    }));
+    });
     self.then = p.then.bind(p);
     self.catch = p.catch.bind(p);
     // if (p.finally) {

package/Emitter.d.ts

@@ -6,9 +6,11 @@
  *
  * Adapted from https://github.com/developit/mitt
  *
- * Regarding typescript support @see:
+ * Regarding typescript support see:
  * - https://stackoverflow.com/q/53299743/1938970
  * - https://github.com/Microsoft/TypeScript/pull/26349
+ *
+ * @category impl
  */
 export declare function Emitter<EventMap extends {
     [key: string]: any;

package/Emitter.mjs

@@ -6,33 +6,32 @@
  *
  * Adapted from https://github.com/developit/mitt
  *
- * Regarding typescript support @see:
+ * Regarding typescript support see:
  * - https://stackoverflow.com/q/53299743/1938970
  * - https://github.com/Microsoft/TypeScript/pull/26349
- */
-export function Emitter(namespace) {
-    var all = new Map();
+ *
+ * @category impl
+ */ export function Emitter(namespace) {
+    const 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);
+     * Register an event handler for the given type.
+     */ on (name, handler) {
+            const handlers = all.get(`${namespace}.${String(name)}`);
+            const added = handlers && handlers.push(handler);
             if (!added) {
-                all.set("".concat(namespace, ".").concat(String(name)), [handler]);
+                all.set(`${namespace}.${String(name)}`, [
+                    handler
+                ]);
             }
         },
         /**
-         * Invoke all handlers for the given type.
-         */
-        emit: function (name, data) {
-            (all.get("".concat(namespace, ".").concat(String(name))) || [])
-                .slice()
-                .map(function (handler) {
+     * Invoke all handlers for the given type.
+     */ emit (name, data) {
+            (all.get(`${namespace}.${String(name)}`) || []).slice().map((handler)=>{
                 handler(data);
             });
-        },
+        }
     };
 }
 export default Emitter;

package/README.md

@@ -11,11 +11,16 @@ Libraries to encapsulate and re-export from here, the selection is based on:
 - [mesqueeb/filter-anything](https://github.com/mesqueeb/filter-anything)
 - [mesqueeb/case-anything](https://github.com/mesqueeb/case-anything)
 - [mesqueeb/nestify-anything](https://github.com/mesqueeb/nestify-anything)
-- [mesqueeb/fast-sort (fork)](https://github.com/mesqueeb/fast-sort (fork))
+- [mesqueeb/fast-sort (fork)](https://github.com/mesqueeb/fast-sort "fork")
 - [mesqueeb/compare-anything](https://github.com/mesqueeb/compare-anything)
 - [mesqueeb/copy-anything](https://github.com/mesqueeb/copy-anything)
 - [mesqueeb/flatten-anything](https://github.com/mesqueeb/flatten-anything)
 
+To considerç
+
+- [dlv](https://www.npmjs.com/package/dlv)
+- [dset](https://github.com/lukeed/dset)
+
 About ts utilities types @see:
 
 - [sindresorhus/type-fest](https://github.com/sindresorhus/type-fest)

package/accentSets.d.ts

@@ -8,8 +8,9 @@ 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
+ * @resources
+ * - https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
+ * - 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[];

package/accentSets.mjs

@@ -1,38 +1,123 @@
 /**
+ * First value is the `to`, second is `from`, from *which* chars do we translates *to*
+ *
+ * @category text
+ */ /**
  * Accent sets
  *
  * @category text
- * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
- * @see https://gist.github.com/eek/9c4887e80b3ede05c0e39fee4dce3747 for usage
+ * @resources
+ * - https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
+ * - 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 var accentsSets = [
-    ["a", "ÀÁÂÃÅÆĀĂĄẠẢẤẦẨẪẬẮẰẲẴẶ"],
-    ["ae", "Ä"],
-    ["c", "ÇĆĈČ"],
-    ["d", "ÐĎĐÞ"],
-    ["e", "ÈÉÊËĒĔĖĘĚẸẺẼẾỀỂỄỆ"],
-    ["g", "ĜĞĢǴ"],
-    ["h", "ĤḦ"],
-    ["i", "ÌÍÎÏĨĪĮİỈỊ"],
-    ["j", "Ĵ"],
-    ["ij", "IJ"],
-    ["k", "Ķ"],
-    ["l", "ĹĻĽŁ"],
-    ["m", "Ḿ"],
-    ["n", "ÑŃŅŇ"],
-    ["o", "ÒÓÔÕØŌŎŐỌỎỐỒỔỖỘỚỜỞỠỢǪǬƠ"],
-    ["oe", "΅"],
-    ["p", "ṕ"],
-    ["r", "ŔŖŘ"],
-    ["s", "ŚŜŞŠ"],
-    ["ss", "ß"],
-    ["t", "ŢŤ"],
-    ["u", "ÙÚÛŨŪŬŮŰŲỤỦỨỪỬỮỰƯ"],
-    ["ue", "Ü"],
-    ["w", "ẂŴẀẄ"],
-    ["x", "ẍ"],
-    ["y", "ÝŶŸỲỴỶỸ"],
-    ["z", "ŹŻŽ"],
+ */ export const accentsSets = [
+    [
+        "a",
+        "ÀÁÂÃÅÆĀĂĄẠẢẤẦẨẪẬẮẰẲẴẶ"
+    ],
+    [
+        "ae",
+        "Ä"
+    ],
+    [
+        "c",
+        "ÇĆĈČ"
+    ],
+    [
+        "d",
+        "ÐĎĐÞ"
+    ],
+    [
+        "e",
+        "ÈÉÊËĒĔĖĘĚẸẺẼẾỀỂỄỆ"
+    ],
+    [
+        "g",
+        "ĜĞĢǴ"
+    ],
+    [
+        "h",
+        "ĤḦ"
+    ],
+    [
+        "i",
+        "ÌÍÎÏĨĪĮİỈỊ"
+    ],
+    [
+        "j",
+        "Ĵ"
+    ],
+    [
+        "ij",
+        "IJ"
+    ],
+    [
+        "k",
+        "Ķ"
+    ],
+    [
+        "l",
+        "ĹĻĽŁ"
+    ],
+    [
+        "m",
+        "Ḿ"
+    ],
+    [
+        "n",
+        "ÑŃŅŇ"
+    ],
+    [
+        "o",
+        "ÒÓÔÕØŌŎŐỌỎỐỒỔỖỘỚỜỞỠỢǪǬƠ"
+    ],
+    [
+        "oe",
+        "΅"
+    ],
+    [
+        "p",
+        "ṕ"
+    ],
+    [
+        "r",
+        "ŔŖŘ"
+    ],
+    [
+        "s",
+        "ŚŜŞŠ"
+    ],
+    [
+        "ss",
+        "ß"
+    ],
+    [
+        "t",
+        "ŢŤ"
+    ],
+    [
+        "u",
+        "ÙÚÛŨŪŬŮŰŲỤỦỨỪỬỮỰƯ"
+    ],
+    [
+        "ue",
+        "Ü"
+    ],
+    [
+        "w",
+        "ẂŴẀẄ"
+    ],
+    [
+        "x",
+        "ẍ"
+    ],
+    [
+        "y",
+        "ÝŶŸỲỴỶỸ"
+    ],
+    [
+        "z",
+        "ŹŻŽ"
+    ]
 ];
 export default accentsSets;

package/addOrReplaceAtIdx.d.ts

@@ -1,4 +1,8 @@
 /**
+ * Add or replace an item in the given array, it returns a new array (immutable).
+ * Typescript wise this is meant to keep the same type on the newly returned
+ * array, therefore the `newItem` must match the type of the `list` items.
+ *
  * @category array
  */
 export declare function addOrReplaceAtIdx<T>(list: T[], newItem: T, newIdx?: number): T[];

package/addOrReplaceAtIdx.mjs

@@ -1,15 +1,22 @@
-import { __spreadArray } from "tslib";
 /**
+ * Add or replace an item in the given array, it returns a new array (immutable).
+ * Typescript wise this is meant to keep the same type on the newly returned
+ * array, therefore the `newItem` must match the type of the `list` items.
+ *
  * @category array
- */
-export function addOrReplaceAtIdx(list, newItem, newIdx) {
+ */ export function addOrReplaceAtIdx(list, newItem, newIdx) {
     if (list.length === 0) {
-        return [newItem];
+        return [
+            newItem
+        ];
     }
     if (typeof newIdx === "undefined" || list.length - 1 < newIdx) {
-        return __spreadArray(__spreadArray([], list, true), [newItem], false);
+        return [
+            ...list,
+            newItem
+        ];
     }
-    return list.map(function (item, idx) {
+    return list.map((item, idx)=>{
         if (idx === newIdx) {
             return newItem;
         }

package/areEqual.d.ts

@@ -13,7 +13,7 @@ type Comparable = ComparablePrimitive | object | Record<string, ComparablePrimit
  * 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
+ * @category object
  */
 export declare function areEqual(a: Comparable, b?: Comparable): boolean;
 export default areEqual;

package/areEqual.mjs

@@ -1,31 +1,26 @@
 import { isArray } from "./isArray";
 import { isObject } from "./isObject";
 function areEqualArrays(a, b) {
-    if (!b)
-        return false;
-    if (a.length !== b.length)
-        return false;
-    for (var i = 0; i < a.length; i++) {
-        var aValue = a[i];
-        var bValue = b[i];
-        if (!areEqual(aValue, bValue))
-            return false;
+    if (!b) return false;
+    if (a.length !== b.length) return false;
+    for(let i = 0; i < a.length; i++){
+        const aValue = a[i];
+        const bValue = b[i];
+        if (!areEqual(aValue, bValue)) return false;
     }
     return true;
 }
 function areEqualObjects(a, b) {
-    if (!b)
-        return false;
-    var aKeys = Object.keys(a);
-    var bKeys = Object.keys(b);
+    if (!b) return false;
+    const aKeys = Object.keys(a);
+    const bKeys = Object.keys(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];
+    for (const _key of aKeys){
+        const key = _key;
+        const aValue = a[key];
+        const bValue = b[key];
         if (!areEqual(aValue, bValue)) {
             return false;
         }
@@ -45,9 +40,8 @@ function areEqualObjects(a, b) {
  * 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 function areEqual(a, b) {
+ * @category object
+ */ export function areEqual(a, b) {
     if (!a && !b) {
         // console.log(`areEqual took ${performance.now() - t0} ms`);
         return true;
@@ -57,12 +51,12 @@ export function areEqual(a, b) {
         // console.log(`areEqual took ${performance.now() - t0} ms`);
         return false;
     }
-    var areObjects = isObject(a) && isObject(b);
+    const areObjects = isObject(a) && isObject(b);
     if (areObjects && !areEqualObjects(a, b)) {
         // console.log(`areEqual took ${performance.now() - t0} ms`);
         return false;
     }
-    var areArrays = isArray(a) && isArray(b);
+    const areArrays = isArray(a) && isArray(b);
     if (areArrays && !areEqualArrays(a, b)) {
         // console.log(`areEqual took ${performance.now() - t0} ms`);
         return false;

package/arrayOfAll.d.ts

@@ -5,8 +5,7 @@
  * @borrows [SO comment by `CertainPerformance`](https://stackoverflow.com/a/60132060/1938970)
  *
  * @usage
- *
- * ```
+ * ```ts
  * type Fruit = "pear" | "apple" | "orange";
  *
  * const arrayOfAllFruits = arrayOfAll<Fruit>();

package/arrayOfAll.mjs

@@ -5,8 +5,7 @@
  * @borrows [SO comment by `CertainPerformance`](https://stackoverflow.com/a/60132060/1938970)
  *
  * @usage
- *
- * ```
+ * ```ts
  * type Fruit = "pear" | "apple" | "orange";
  *
  * const arrayOfAllFruits = arrayOfAll<Fruit>();
@@ -23,10 +22,5 @@
  * ]); // ts compiler fails
  * ```
  *
- */
-export var arrayOfAll = function () {
-    return function (array) {
-        return array;
-    };
-};
+ */ export const arrayOfAll = ()=>(array)=>array;
 export default arrayOfAll;

package/arraySum.d.ts

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

package/arraySum.mjs

@@ -1,9 +1,7 @@
 /**
  * Sum array of numbers
  *
- * @category array | math
- */
-export var arraySum = function (numbers) {
-    return numbers.reduce(function (sum, current) { return sum + current; }, 0);
-};
+ * @category array
+ * @category math
+ */ export const arraySum = (numbers)=>numbers.reduce((sum, current)=>sum + current, 0);
 export default arraySum;

package/arrayToLookup.mjs

@@ -2,10 +2,8 @@
  * Maps a simple flat array to a lookup dictionary object
  *
  * @category array
- */
-export function arrayToLookup(array) {
-    if (array === void 0) { array = []; }
-    return array.reduce(function (obj, item) {
+ */ export function arrayToLookup(array = []) {
+    return array.reduce((obj, item)=>{
         obj[item] = 1;
         return obj;
     }, {});

package/buildUrlQueryString.mjs

@@ -1,6 +1,6 @@
+import isArray from "./isArray";
 import isNull from "./isNull";
 import isUndefined from "./isUndefined";
-import isArray from "./isArray";
 /**
  * Get clean query string for URL
  *
@@ -9,23 +9,20 @@ import isArray from "./isArray";
  * TODO: at some point replace with `URLSearchParams`, @see [caniuse](https://caniuse.com/?search=URLSearchParams)
  *
  * @category location
- */
-export function buildUrlQueryString(params) {
-    var output = "";
-    if (!params)
-        return output;
-    for (var key in params) {
-        var value = params[key];
+ */ export function buildUrlQueryString(params) {
+    let output = "";
+    if (!params) return output;
+    for(const key in params){
+        const value = params[key];
         if (isArray(value)) {
-            for (var i = 0; i < value.length; i++) {
-                output += "".concat(key, "=").concat(encodeURIComponent(value[i] + ""), "&");
+            for(let i = 0; i < value.length; i++){
+                output += `${key}=${encodeURIComponent(value[i] + "")}&`;
             }
-        }
-        else if (!isNull(value) && !isUndefined(value)) {
-            output += "".concat(key, "=").concat(encodeURIComponent(value + ""), "&");
+        } else if (!isNull(value) && !isUndefined(value)) {
+            output += `${key}=${encodeURIComponent(value + "")}&`;
         }
     }
     // removes the last &
-    return output ? "?".concat(output.replace(/&+$/, "")) : "";
+    return output ? `?${output.replace(/&+$/, "")}` : "";
 }
 export default buildUrlQueryString;

package/capitalize.d.ts

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

package/capitalize.mjs

@@ -2,11 +2,10 @@
  * Capitalize first letter of the given string.
  *
  * @category text
- * @see https://stackoverflow.com/a/11409944/1938970
- */
-export function capitalize(string) {
-    var ensuredString = string || "";
-    return (ensuredString.charAt(0).toUpperCase() +
-        ensuredString.slice(1));
+ * @resources
+ * - https://stackoverflow.com/a/11409944/1938970
+ */ export function capitalize(string) {
+    const ensuredString = string || "";
+    return ensuredString.charAt(0).toUpperCase() + ensuredString.slice(1);
 }
 export default capitalize;

package/changeUrlPath.mjs

@@ -7,9 +7,8 @@ import normaliseUrlPathname from "./normaliseUrlPathname";
  * @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 function changeUrlPath(pathname, state, replace) {
-    var path = normaliseUrlPathname("/".concat(pathname, "/"));
+ */ export function changeUrlPath(pathname, state, replace) {
+    const path = normaliseUrlPathname(`/${pathname}/`);
     if (isBrowser) {
         history[replace ? "replaceState" : "pushState"](state, "", path);
     }

package/chunkByChunks.d.ts

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

package/chunkByChunks.mjs

@@ -1,34 +1,31 @@
 /**
- * TODO: untested
  * @category array
  * @see https://stackoverflow.com/a/8189268/1938970
- */
-export function chunkByChunks(arr, nrOfChunks, balanced) {
-    if (nrOfChunks < 2)
-        return [arr];
-    var len = arr.length;
-    var output = [];
-    var i = 0;
-    var size;
+ * @experimental TODO: untested
+ */ export function chunkByChunks(arr, nrOfChunks, balanced) {
+    if (nrOfChunks < 2) return [
+        arr
+    ];
+    const len = arr.length;
+    const output = [];
+    let i = 0;
+    let size;
     if (len % nrOfChunks === 0) {
         size = Math.floor(len / nrOfChunks);
-        while (i < len) {
-            output.push(arr.slice(i, (i += size)));
+        while(i < len){
+            output.push(arr.slice(i, i += size));
         }
-    }
-    else if (balanced) {
-        while (i < len) {
+    } else if (balanced) {
+        while(i < len){
             size = Math.ceil((len - i) / nrOfChunks--);
-            output.push(arr.slice(i, (i += size)));
+            output.push(arr.slice(i, i += size));
         }
-    }
-    else {
+    } else {
         nrOfChunks--;
         size = Math.floor(len / nrOfChunks);
-        if (len % size === 0)
-            size--;
-        while (i < size * nrOfChunks) {
-            output.push(arr.slice(i, (i += size)));
+        if (len % size === 0) size--;
+        while(i < size * nrOfChunks){
+            output.push(arr.slice(i, i += size));
         }
         output.push(arr.slice(size * nrOfChunks));
     }

package/chunkBySize.mjs

@@ -1,10 +1,9 @@
 /**
  * @category array
  * @see https://stackoverflow.com/a/40682136/1938970
- */
-export function chunkBySize(arr, size) {
-    var output = [];
-    for (var i = 0; i < arr.length; i += size) {
+ */ export function chunkBySize(arr, size) {
+    const output = [];
+    for(let i = 0; i < arr.length; i += size){
         output.push(arr.slice(i, i + size));
     }
     return output;

package/clamp.mjs

@@ -3,8 +3,7 @@
  *
  * @category math
  * @see https://stackoverflow.com/a/11409944/1938970
- */
-export function clamp(num, min, max) {
+ */ export function clamp(num, min, max) {
     return Math.min(Math.max(num, min), max);
 }
 export default clamp;