@koine/utils 2.0.0-beta.80 → 2.0.0-beta.83

package/createPalette.esm.js

@@ -1,13 +1,19 @@
-let createPalette = (name, shades) => {
-    const map = shades.reduce((map, def) => {
-        map[def[0]] = def[1];
-        return map;
-    }, {});
-    const tailwindPalette = shades.reduce((map, def) => {
-        map[`${name}-${def[0]}`] = def[1];
-        return map;
-    }, {});
-    return [map, tailwindPalette, Object.values(map)];
-};
+/**
+ * Create palette, this is primarily thought to improve the reuse of a palette
+ * definition between TailwindCSS and straight ES imports
+ *
+ * @category colors
+ * @category tailwind
+ * @category responsive
+ *
+ * @returns An array with: 1) A flat palette map 2) A TailwindCSS ready palette
+ * object 3) A flat array of colors (no special sorting, same order as the `shades`
+ * given as argument)
+ */let createPalette=(e,t)=>{let r=t.reduce((e,t)=>(e[t[0]]=t[1],e),{});return [r,// NOTE: the following breaks typedoc, with `any` it compiles
+// const map = shades.reduce((map, def) => {
+//   map[def[0]] = def[1] as TColor;
+//   return map;
+// }, {} as { [s: string]: TColor });
+t.reduce((t,r)=>(t[`${e}-${r[0]}`]=r[1],t),{}),Object.values(r)]};
 
 export { createPalette, createPalette as default };

package/debounce.cjs.js

@@ -2,23 +2,13 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let debounce = (fn, wait, immediate) => {
-    let timeout;
-    return function (...args) {
-        const context = this;
-        const later = function () {
-            timeout = null;
-            if (!immediate)
-                fn.apply(context, args);
-        };
-        const callNow = immediate && !timeout;
-        if (timeout)
-            clearTimeout(timeout);
-        timeout = setTimeout(later, wait);
-        if (callNow)
-            fn.apply(context, args);
-    };
-};
+/**
+ * Debounce function (with `setTimeout`)
+ *
+ * @category function
+ * @borrows [davidwalsh/debounce](https://davidwalsh.name/javascript-debounce-function)
+ */let debounce=(e,t,l)=>{let u;return function(...n){// eslint-disable-next-line @typescript-eslint/no-this-alias
+let o=this,p=l&&!u;u&&clearTimeout(u),u=setTimeout(function(){u=null,l||e.apply(o,n);},t),p&&e.apply(o,n);}};
 
 exports.debounce = debounce;
 exports["default"] = debounce;

package/debounce.esm.js

@@ -1,19 +1,9 @@
-let debounce = (fn, wait, immediate) => {
-    let timeout;
-    return function (...args) {
-        const context = this;
-        const later = function () {
-            timeout = null;
-            if (!immediate)
-                fn.apply(context, args);
-        };
-        const callNow = immediate && !timeout;
-        if (timeout)
-            clearTimeout(timeout);
-        timeout = setTimeout(later, wait);
-        if (callNow)
-            fn.apply(context, args);
-    };
-};
+/**
+ * Debounce function (with `setTimeout`)
+ *
+ * @category function
+ * @borrows [davidwalsh/debounce](https://davidwalsh.name/javascript-debounce-function)
+ */let debounce=(e,t,l)=>{let u;return function(...n){// eslint-disable-next-line @typescript-eslint/no-this-alias
+let o=this,p=l&&!u;u&&clearTimeout(u),u=setTimeout(function(){u=null,l||e.apply(o,n);},t),p&&e.apply(o,n);}};
 
 export { debounce, debounce as default };

package/debouncePromise.cjs.js

@@ -2,57 +2,22 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let debouncePromise = (func, waitMilliseconds = 50, options = {}) => {
-    let timeoutId;
-    const isImmediate = options.isImmediate ?? false;
-    const callback = options.callback ?? false;
-    const maxWait = options.maxWait;
-    let lastInvokeTime = Date.now();
-    let promises = [];
-    function nextInvokeTimeout() {
-        if (maxWait !== undefined) {
-            const timeSinceLastInvocation = Date.now() - lastInvokeTime;
-            if (timeSinceLastInvocation + waitMilliseconds >= maxWait) {
-                return maxWait - timeSinceLastInvocation;
-            }
-        }
-        return waitMilliseconds;
-    }
-    const debouncedFunction = function (...args) {
-        const context = this;
-        return new Promise((resolve, reject) => {
-            const invokeFunction = function () {
-                timeoutId = undefined;
-                lastInvokeTime = Date.now();
-                if (!isImmediate) {
-                    const result = func.apply(context, args);
-                    callback && callback(result);
-                    promises.forEach(({ resolve }) => resolve(result));
-                    promises = [];
-                }
-            };
-            const shouldCallNow = isImmediate && timeoutId === undefined;
-            if (timeoutId !== undefined) {
-                clearTimeout(timeoutId);
-            }
-            timeoutId = setTimeout(invokeFunction, nextInvokeTimeout());
-            if (shouldCallNow) {
-                const result = func.apply(context, args);
-                callback && callback(result);
-                return resolve(result);
-            }
-            promises.push({ resolve, reject });
-        });
-    };
-    debouncedFunction.cancel = function (reason) {
-        if (timeoutId !== undefined) {
-            clearTimeout(timeoutId);
-        }
-        promises.forEach(({ reject }) => reject(reason));
-        promises = [];
-    };
-    return debouncedFunction;
-};
+/**
+ * Copy pasted from [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce/blob/master/src/index.ts)
+ *
+ * @module
+ *//**
+ * @categroy functionn
+ *//**
+ * @categroy functionn
+ *//**
+ * Debounce function (with `Promise`)
+ *
+ * @category function
+ * @borrows [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce)
+ * @license MIT: Jakub Chodorowicz
+ */let debouncePromise=(e,t=50,o={})=>{let i;let n=o.isImmediate??!1,r=o.callback??!1,a=o.maxWait,l=Date.now(),u=[],c=function(...o){// eslint-disable-next-line @typescript-eslint/no-this-alias
+let c=this;return new Promise((f,d)=>{let m=n&&void 0===i;if(void 0!==i&&clearTimeout(i),i=setTimeout(function(){if(i=void 0,l=Date.now(),!n){let t=e.apply(c,o);r&&r(t),u.forEach(({resolve:e})=>e(t)),u=[];}},function(){if(void 0!==a){let e=Date.now()-l;if(e+t>=a)return a-e}return t}()),m){let t=e.apply(c,o);return r&&r(t),f(t)}u.push({resolve:f,reject:d});})};return c.cancel=function(e){void 0!==i&&clearTimeout(i),u.forEach(({reject:t})=>t(e)),u=[];},c};
 
 exports.debouncePromise = debouncePromise;
 exports["default"] = debouncePromise;

package/debouncePromise.esm.js

@@ -1,53 +1,18 @@
-let debouncePromise = (func, waitMilliseconds = 50, options = {}) => {
-    let timeoutId;
-    const isImmediate = options.isImmediate ?? false;
-    const callback = options.callback ?? false;
-    const maxWait = options.maxWait;
-    let lastInvokeTime = Date.now();
-    let promises = [];
-    function nextInvokeTimeout() {
-        if (maxWait !== undefined) {
-            const timeSinceLastInvocation = Date.now() - lastInvokeTime;
-            if (timeSinceLastInvocation + waitMilliseconds >= maxWait) {
-                return maxWait - timeSinceLastInvocation;
-            }
-        }
-        return waitMilliseconds;
-    }
-    const debouncedFunction = function (...args) {
-        const context = this;
-        return new Promise((resolve, reject) => {
-            const invokeFunction = function () {
-                timeoutId = undefined;
-                lastInvokeTime = Date.now();
-                if (!isImmediate) {
-                    const result = func.apply(context, args);
-                    callback && callback(result);
-                    promises.forEach(({ resolve }) => resolve(result));
-                    promises = [];
-                }
-            };
-            const shouldCallNow = isImmediate && timeoutId === undefined;
-            if (timeoutId !== undefined) {
-                clearTimeout(timeoutId);
-            }
-            timeoutId = setTimeout(invokeFunction, nextInvokeTimeout());
-            if (shouldCallNow) {
-                const result = func.apply(context, args);
-                callback && callback(result);
-                return resolve(result);
-            }
-            promises.push({ resolve, reject });
-        });
-    };
-    debouncedFunction.cancel = function (reason) {
-        if (timeoutId !== undefined) {
-            clearTimeout(timeoutId);
-        }
-        promises.forEach(({ reject }) => reject(reason));
-        promises = [];
-    };
-    return debouncedFunction;
-};
+/**
+ * Copy pasted from [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce/blob/master/src/index.ts)
+ *
+ * @module
+ *//**
+ * @categroy functionn
+ *//**
+ * @categroy functionn
+ *//**
+ * Debounce function (with `Promise`)
+ *
+ * @category function
+ * @borrows [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce)
+ * @license MIT: Jakub Chodorowicz
+ */let debouncePromise=(e,t=50,o={})=>{let i;let n=o.isImmediate??!1,r=o.callback??!1,a=o.maxWait,l=Date.now(),u=[],c=function(...o){// eslint-disable-next-line @typescript-eslint/no-this-alias
+let c=this;return new Promise((f,d)=>{let m=n&&void 0===i;if(void 0!==i&&clearTimeout(i),i=setTimeout(function(){if(i=void 0,l=Date.now(),!n){let t=e.apply(c,o);r&&r(t),u.forEach(({resolve:e})=>e(t)),u=[];}},function(){if(void 0!==a){let e=Date.now()-l;if(e+t>=a)return a-e}return t}()),m){let t=e.apply(c,o);return r&&r(t),f(t)}u.push({resolve:f,reject:d});})};return c.cancel=function(e){void 0!==i&&clearTimeout(i),u.forEach(({reject:t})=>t(e)),u=[];},c};
 
 export { debouncePromise, debouncePromise as default };

package/debounceRaf.cjs.js

@@ -2,18 +2,16 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-function debounceRaf(fn) {
-    let timeout;
-    return function (...args) {
-        const context = this;
-        if (timeout) {
-            window.cancelAnimationFrame(timeout);
-        }
-        timeout = window.requestAnimationFrame(function () {
-            fn.apply(context, args);
-        });
-    };
-}
+/**
+ * Debounce function (with `requestAnimationFrame`)
+ *
+ * @category function
+ * @borrows [vanillajstoolkit/debounce](https://vanillajstoolkit.com/helpers/debounce/)
+ * @license (c) 2021 Chris Ferdinandi, MIT License, https://gomakethings.com
+ */function debounceRaf(n){let e;return function(...t){// eslint-disable-next-line @typescript-eslint/no-this-alias
+let o=this;// If there's a timer, cancel it
+e&&window.cancelAnimationFrame(e),// Setup the new requestAnimationFrame()
+e=window.requestAnimationFrame(function(){n.apply(o,t);});}}
 
 exports.debounceRaf = debounceRaf;
 exports["default"] = debounceRaf;

package/debounceRaf.esm.js

@@ -1,14 +1,12 @@
-function debounceRaf(fn) {
-    let timeout;
-    return function (...args) {
-        const context = this;
-        if (timeout) {
-            window.cancelAnimationFrame(timeout);
-        }
-        timeout = window.requestAnimationFrame(function () {
-            fn.apply(context, args);
-        });
-    };
-}
+/**
+ * Debounce function (with `requestAnimationFrame`)
+ *
+ * @category function
+ * @borrows [vanillajstoolkit/debounce](https://vanillajstoolkit.com/helpers/debounce/)
+ * @license (c) 2021 Chris Ferdinandi, MIT License, https://gomakethings.com
+ */function debounceRaf(n){let e;return function(...t){// eslint-disable-next-line @typescript-eslint/no-this-alias
+let o=this;// If there's a timer, cancel it
+e&&window.cancelAnimationFrame(e),// Setup the new requestAnimationFrame()
+e=window.requestAnimationFrame(function(){n.apply(o,t);});}}
 
 export { debounceRaf, debounceRaf as default };

package/decode.cjs.js

@@ -2,7 +2,10 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let decode = (str) => str.replace(/.{3}/g, (c) => String.fromCharCode(parseInt(c, 10)));
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */let decode=e=>e.replace(/.{3}/g,e=>String.fromCharCode(parseInt(e,10)));
 
 exports.decode = decode;
 exports["default"] = decode;

package/decode.esm.js

@@ -1,3 +1,6 @@
-let decode = (str) => str.replace(/.{3}/g, (c) => String.fromCharCode(parseInt(c, 10)));
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */let decode=e=>e.replace(/.{3}/g,e=>String.fromCharCode(parseInt(e,10)));
 
 export { decode, decode as default };

package/encode.cjs.js

@@ -2,7 +2,10 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let encode = (str) => str.replace(/./g, (c) => ("00" + c.charCodeAt(0)).slice(-3));
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */let encode=e=>e.replace(/./g,e=>("00"+e.charCodeAt(0)).slice(-3));
 
 exports["default"] = encode;
 exports.encode = encode;

package/encode.esm.js

@@ -1,3 +1,6 @@
-let encode = (str) => str.replace(/./g, (c) => ("00" + c.charCodeAt(0)).slice(-3));
+/**
+ * @category security
+ * @see https://stackoverflow.com/a/22405578/9122820
+ */let encode=e=>e.replace(/./g,e=>("00"+e.charCodeAt(0)).slice(-3));
 
 export { encode as default, encode };

package/ensureInt.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let ensureInt = (input) => typeof input === "string" ? parseInt(input, 10) : Math.round(input);
+/**
+ * Ensure input to be an integer
+ *
+ * @category cast
+ */let ensureInt=e=>"string"==typeof e?parseInt(e,10):Math.round(e);
 
 exports["default"] = ensureInt;
 exports.ensureInt = ensureInt;

package/ensureInt.esm.js

@@ -1,3 +1,7 @@
-let ensureInt = (input) => typeof input === "string" ? parseInt(input, 10) : Math.round(input);
+/**
+ * Ensure input to be an integer
+ *
+ * @category cast
+ */let ensureInt=e=>"string"==typeof e?parseInt(e,10):Math.round(e);
 
 export { ensureInt as default, ensureInt };

package/errorToString.cjs.js

@@ -5,7 +5,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isString = require('./isString.cjs.js');
 require('./getType.cjs.js');
 
-let errorToString = (e) => e instanceof Error ? e.message : isString.isString(e) ? e : "";
+/**
+ * Ensure to transform a JavaScript `Error` into a string (uses its `message`)
+ *
+ * @category error
+ * @category cast
+ */let errorToString=o=>o instanceof Error?o.message:isString.isString(o)?o:"";
 
 exports["default"] = errorToString;
 exports.errorToString = errorToString;

package/errorToString.esm.js

@@ -1,6 +1,11 @@
 import { isString } from './isString.esm.js';
 import './getType.esm.js';
 
-let errorToString = (e) => e instanceof Error ? e.message : isString(e) ? e : "";
+/**
+ * Ensure to transform a JavaScript `Error` into a string (uses its `message`)
+ *
+ * @category error
+ * @category cast
+ */let errorToString=o=>o instanceof Error?o.message:isString(o)?o:"";
 
 export { errorToString as default, errorToString };

package/escapeRegExp.cjs.js

@@ -2,7 +2,13 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let escapeRegExp = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+/**
+ * @borrows [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions)
+ * @borrows [SO's answer by Mathias Bynens](https://stackoverflow.com/a/9310752/1938970)
+ *
+ * @category escape
+ * @category RegExp
+ */let escapeRegExp=e=>e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&");// text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
 
 exports["default"] = escapeRegExp;
 exports.escapeRegExp = escapeRegExp;

package/escapeRegExp.esm.js

@@ -1,3 +1,9 @@
-let escapeRegExp = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+/**
+ * @borrows [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions)
+ * @borrows [SO's answer by Mathias Bynens](https://stackoverflow.com/a/9310752/1938970)
+ *
+ * @category escape
+ * @category RegExp
+ */let escapeRegExp=e=>e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&");// text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
 
 export { escapeRegExp as default, escapeRegExp };

package/findDuplicatedIndexes.cjs.js

@@ -2,16 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let findDuplicatedIndexes = (arr) => {
-    const indexes = {};
-    for (let i = 0; i < arr.length; i++) {
-        const idxInArray = arr.indexOf(arr[i]);
-        if (idxInArray !== i && idxInArray !== -1) {
-            indexes[i] = true;
-        }
-    }
-    return indexes;
-};
+/**
+ * @category array
+ */let findDuplicatedIndexes=e=>{let t={};for(let d=0;d<e.length;d++){let l=e.indexOf(e[d]);l!==d&&-1!==l&&(t[d]=!0);}return t};
 
 exports["default"] = findDuplicatedIndexes;
 exports.findDuplicatedIndexes = findDuplicatedIndexes;

package/findDuplicatedIndexes.esm.js

@@ -1,12 +1,5 @@
-let findDuplicatedIndexes = (arr) => {
-    const indexes = {};
-    for (let i = 0; i < arr.length; i++) {
-        const idxInArray = arr.indexOf(arr[i]);
-        if (idxInArray !== i && idxInArray !== -1) {
-            indexes[i] = true;
-        }
-    }
-    return indexes;
-};
+/**
+ * @category array
+ */let findDuplicatedIndexes=e=>{let t={};for(let d=0;d<e.length;d++){let l=e.indexOf(e[d]);l!==d&&-1!==l&&(t[d]=!0);}return t};
 
 export { findDuplicatedIndexes as default, findDuplicatedIndexes };

package/forin.cjs.js

@@ -2,11 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let forin = (object, cb) => {
-    for (const key in object) {
-        cb(key, object[key]);
-    }
-};
+/**
+ * To easily get typed native `for in`
+ *
+ * @category native
+ * @category object
+ */let forin=(e,o)=>{for(let r in e)o(r,e[r]);};
 
 exports["default"] = forin;
 exports.forin = forin;

package/forin.esm.js

@@ -1,7 +1,8 @@
-let forin = (object, cb) => {
-    for (const key in object) {
-        cb(key, object[key]);
-    }
-};
+/**
+ * To easily get typed native `for in`
+ *
+ * @category native
+ * @category object
+ */let forin=(e,o)=>{for(let r in e)o(r,e[r]);};
 
 export { forin as default, forin };

package/gbToBytes.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let gbToBytes = (bytes) => bytes * 1000 * 1000 * 1000;
+/**
+ * Gigabytes to bytes
+ *
+ * @category format
+ */let gbToBytes=e=>1e9*e;
 
 exports["default"] = gbToBytes;
 exports.gbToBytes = gbToBytes;

package/gbToBytes.esm.js

@@ -1,3 +1,7 @@
-let gbToBytes = (bytes) => bytes * 1000 * 1000 * 1000;
+/**
+ * Gigabytes to bytes
+ *
+ * @category format
+ */let gbToBytes=e=>1e9*e;
 
 export { gbToBytes as default, gbToBytes };

package/getEmptyArray.cjs.js

@@ -5,9 +5,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isNumber = require('./isNumber.cjs.js');
 require('./getType.cjs.js');
 
-let getEmptyArray = (length) => Array.from({
-    length: !isNumber.isNumber(length) ? parseInt(length, 10) : length,
-});
+/**
+ * Returns an array of undefined values of the desired length, useful to build
+ * skeleton UIs.
+ *
+ * @category array
+ */let getEmptyArray=/* <T extends undefined | null = undefined> */t=>Array.from({length:isNumber.isNumber(t)?t:parseInt(t,10)});
 
 exports["default"] = getEmptyArray;
 exports.getEmptyArray = getEmptyArray;

package/getEmptyArray.esm.js

@@ -1,8 +1,11 @@
 import { isNumber } from './isNumber.esm.js';
 import './getType.esm.js';
 
-let getEmptyArray = (length) => Array.from({
-    length: !isNumber(length) ? parseInt(length, 10) : length,
-});
+/**
+ * Returns an array of undefined values of the desired length, useful to build
+ * skeleton UIs.
+ *
+ * @category array
+ */let getEmptyArray=/* <T extends undefined | null = undefined> */t=>Array.from({length:isNumber(t)?t:parseInt(t,10)});
 
 export { getEmptyArray as default, getEmptyArray };

package/getKeys.cjs.js

@@ -2,7 +2,14 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getKeys = Object.keys;
+/**
+ * Type safe replacement for `Object.keys(myObject)` to iterate over a record
+ * without loosing the key's types in simple `string`s.
+ *
+ * @category native
+ * @category object
+ * @see https://stackoverflow.com/a/59459000/1938970
+ */let getKeys=Object.keys;
 
 exports["default"] = getKeys;
 exports.getKeys = getKeys;

package/getKeys.d.ts

@@ -1,2 +1,2 @@
-export declare let getKeys: <T extends object>(obj: T) => (keyof T)[];
+export declare let getKeys: <T extends object>(obj: T) => Array<keyof T>;
 export default getKeys;

package/getKeys.esm.js

@@ -1,3 +1,10 @@
-let getKeys = Object.keys;
+/**
+ * Type safe replacement for `Object.keys(myObject)` to iterate over a record
+ * without loosing the key's types in simple `string`s.
+ *
+ * @category native
+ * @category object
+ * @see https://stackoverflow.com/a/59459000/1938970
+ */let getKeys=Object.keys;
 
 export { getKeys as default, getKeys };