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

package/shuffle.esm.js

@@ -1,18 +1,17 @@
-let shuffle = (array) => {
-    const length = array == null ? 0 : array.length;
-    if (!length) {
-        return [];
-    }
-    let index = -1;
-    const lastIndex = length - 1;
-    const result = [...array];
-    while (++index < length) {
-        const rand = index + Math.floor(Math.random() * (lastIndex - index + 1));
-        const value = result[rand];
-        result[rand] = result[index];
-        result[index] = value;
-    }
-    return result;
-};
+/**
+ * Creates an array of shuffled values, using a version of the
+ * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
+ *
+ * @category array
+ * @borrows [lodash.shuffle](https://github.com/lodash/lodash/blob/master/shuffle.js)
+ * @example
+ * ```ts
+ * shuffle([1, 2, 3, 4])
+ * // => [4, 1, 3, 2]
+ * ```
+ *
+ * @param array The array to shuffle.
+ * @returns The new shuffled array.
+ */let shuffle=e=>{let t=null==e?0:e.length;if(!t)return [];let l=-1,r=t-1,f=[...e];for(;++l<t;){let e=l+Math.floor(Math.random()*(r-l+1)),t=f[e];f[e]=f[l],f[l]=t;}return f};
 
 export { shuffle as default, shuffle };

package/slugify.cjs.js

@@ -2,17 +2,28 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var accentSets = require('./accentSets.cjs.js');
+var accentsSets = require('./accentsSets.cjs.js');
 var removeAccents = require('./removeAccents.cjs.js');
 
-let slugify = (text, separator = "-") => removeAccents.removeAccents(text.toString().toLowerCase().trim(), accentSets.accentsSets.concat([["-", "[·/_,:;']"]]))
-    .replace(/\s+/g, "-")
-    .replace(/&/g, "-and-")
-    .replace(/[^\w-]+/g, "")
-    .replace(/--+/g, "-")
-    .replace(/^-+/, "")
-    .replace(/-+$/, "")
-    .replace(/-/g, separator);
+/**
+ * Slugify a text
+ *
+ * - replaces the accented letters
+ * - replaces the punctuation with dashes
+ *
+ * @category text
+ *
+ * @borrows [mathewbyrne's gist](https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021)
+ */let slugify=(t,c="-")=>removeAccents.removeAccents(t.toString().toLowerCase().trim(),accentsSets.accentsSets.concat([["-","[·/_,:;']"]])).replace(/\s+/g,"-").// replace spaces with -
+    // .replace(/&/g, "-and-") // replace & with 'and'
+    // it used to be:
+    // .replace(/[^\w-]+/g, "") // remove all non-word chars
+    // and now with chinese support @see https://stackoverflow.com/a/25698970
+    replace(/[^a-zA-Z0-9_\u3400-\u9FBF\s-]+/g,"").// remove all non-word chars
+    replace(/--+/g,"-").// replace multiple - with single -
+    replace(/^-+/,"").// trim - from start of text
+    replace(/-+$/,"").// trim - from end of text
+    replace(/-/g,c);
 
 exports["default"] = slugify;
 exports.slugify = slugify;

package/slugify.esm.js

@@ -1,13 +1,24 @@
-import { accentsSets } from './accentSets.esm.js';
+import { accentsSets } from './accentsSets.esm.js';
 import { removeAccents } from './removeAccents.esm.js';
 
-let slugify = (text, separator = "-") => removeAccents(text.toString().toLowerCase().trim(), accentsSets.concat([["-", "[·/_,:;']"]]))
-    .replace(/\s+/g, "-")
-    .replace(/&/g, "-and-")
-    .replace(/[^\w-]+/g, "")
-    .replace(/--+/g, "-")
-    .replace(/^-+/, "")
-    .replace(/-+$/, "")
-    .replace(/-/g, separator);
+/**
+ * Slugify a text
+ *
+ * - replaces the accented letters
+ * - replaces the punctuation with dashes
+ *
+ * @category text
+ *
+ * @borrows [mathewbyrne's gist](https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021)
+ */let slugify=(t,c="-")=>removeAccents(t.toString().toLowerCase().trim(),accentsSets.concat([["-","[·/_,:;']"]])).replace(/\s+/g,"-").// replace spaces with -
+    // .replace(/&/g, "-and-") // replace & with 'and'
+    // it used to be:
+    // .replace(/[^\w-]+/g, "") // remove all non-word chars
+    // and now with chinese support @see https://stackoverflow.com/a/25698970
+    replace(/[^a-zA-Z0-9_\u3400-\u9FBF\s-]+/g,"").// remove all non-word chars
+    replace(/--+/g,"-").// replace multiple - with single -
+    replace(/^-+/,"").// trim - from start of text
+    replace(/-+$/,"").// trim - from end of text
+    replace(/-/g,c);
 
 export { slugify as default, slugify };

package/split.cjs.js

@@ -2,7 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let split = (string, delimiter) => string.split(delimiter);
+/**
+ * Quick typed replacement for `string.split("delimiter")`
+ *
+ * @category string
+ * @category text
+ */let split=(t,l)=>t.split(l);
 
 exports["default"] = split;
 exports.split = split;

package/split.esm.js

@@ -1,3 +1,8 @@
-let split = (string, delimiter) => string.split(delimiter);
+/**
+ * Quick typed replacement for `string.split("delimiter")`
+ *
+ * @category string
+ * @category text
+ */let split=(t,l)=>t.split(l);
 
 export { split as default, split };

package/splitReverse.cjs.js

@@ -2,7 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let splitReverse = (string, delimiter) => string.split(delimiter).reverse();
+/**
+ * Quick typed replacement for `string.split("delimiter").reverse()`
+ *
+ * @category string
+ * @category text
+ */let splitReverse=(e,t)=>e.split(t).reverse();
 
 exports["default"] = splitReverse;
 exports.splitReverse = splitReverse;

package/splitReverse.esm.js

@@ -1,3 +1,8 @@
-let splitReverse = (string, delimiter) => string.split(delimiter).reverse();
+/**
+ * Quick typed replacement for `string.split("delimiter").reverse()`
+ *
+ * @category string
+ * @category text
+ */let splitReverse=(e,t)=>e.split(t).reverse();
 
 export { splitReverse as default, splitReverse };

package/swapMap.cjs.js

@@ -2,13 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let swapMap = (map = {}) => {
-    const output = {};
-    for (const key in map) {
-        output[map[key]] = key;
-    }
-    return output;
-};
+/**
+ * Swap object map key/value
+ *
+ * @category object
+ */let swapMap=(e={})=>{let t={};for(let p in e)t[e[p]]=p;return t};
 
 exports["default"] = swapMap;
 exports.swapMap = swapMap;

package/swapMap.esm.js

@@ -1,9 +1,7 @@
-let swapMap = (map = {}) => {
-    const output = {};
-    for (const key in map) {
-        output[map[key]] = key;
-    }
-    return output;
-};
+/**
+ * Swap object map key/value
+ *
+ * @category object
+ */let swapMap=(e={})=>{let t={};for(let p in e)t[e[p]]=p;return t};
 
 export { swapMap as default, swapMap };

package/throttle.cjs.js

@@ -2,20 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let throttle = (fn, limit, context) => {
-    let wait;
-    return function (...args) {
-        context = context || this;
-        if (!wait) {
-            fn.apply(context, ...args);
-            wait = true;
-            return setTimeout(function () {
-                wait = false;
-            }, limit);
-        }
-        return;
-    };
-};
+/**
+ * Throttle function (e.g. for resize / scroll handlers)
+ *
+ * @category function
+ * @borrows [Mobius1/Rangeable](https://github.com/Mobius1/Rangeable/)
+ */let throttle=(t,e,r)=>{let o;return function(...l){if(r=r||this,!o)return t.apply(r,...l),o=!0,setTimeout(function(){o=!1;},e)}};
 
 exports["default"] = throttle;
 exports.throttle = throttle;

package/throttle.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="node" />
-export declare let throttle: <TFn extends Function, TContext>(fn: TFn, limit: number, context?: TContext | undefined) => (this: TContext, ...args: any[]) => NodeJS.Timeout | undefined;
+export declare let throttle: <TFn extends Function, TContext>(fn: TFn, limit: number, context?: TContext) => (this: TContext, ...args: any[]) => NodeJS.Timeout | undefined;
 export default throttle;

package/throttle.esm.js

@@ -1,16 +1,8 @@
-let throttle = (fn, limit, context) => {
-    let wait;
-    return function (...args) {
-        context = context || this;
-        if (!wait) {
-            fn.apply(context, ...args);
-            wait = true;
-            return setTimeout(function () {
-                wait = false;
-            }, limit);
-        }
-        return;
-    };
-};
+/**
+ * Throttle function (e.g. for resize / scroll handlers)
+ *
+ * @category function
+ * @borrows [Mobius1/Rangeable](https://github.com/Mobius1/Rangeable/)
+ */let throttle=(t,e,r)=>{let o;return function(...l){if(r=r||this,!o)return t.apply(r,...l),o=!0,setTimeout(function(){o=!1;},e)}};
 
 export { throttle as default, throttle };

package/titleCase.cjs.js

@@ -2,9 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let titleCase = (input) => input
-    ? input.replace(/\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase())
-    : "";
+/**
+ * @category text
+ *
+ * @borrows [blakeembrey/change-case](https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts)
+ * @license Blake Embrey (hello@blakeembrey.com)
+ */let titleCase=e=>e?e.replace(/\w\S*/g,e=>e.charAt(0).toUpperCase()+e.substring(1).toLowerCase()):"";
 
 exports["default"] = titleCase;
 exports.titleCase = titleCase;

package/titleCase.esm.js

@@ -1,5 +1,8 @@
-let titleCase = (input) => input
-    ? input.replace(/\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase())
-    : "";
+/**
+ * @category text
+ *
+ * @borrows [blakeembrey/change-case](https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts)
+ * @license Blake Embrey (hello@blakeembrey.com)
+ */let titleCase=e=>e?e.replace(/\w\S*/g,e=>e.charAt(0).toUpperCase()+e.substring(1).toLowerCase()):"";
 
 export { titleCase as default, titleCase };

package/toNumber.cjs.js

@@ -5,7 +5,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isNumber = require('./isNumber.cjs.js');
 require('./getType.cjs.js');
 
-let toNumber = (input, fallback) => isNumber.isNumber(input) ? input : input ? parseFloat(input) : fallback || 0;
+/**
+ * @category cast
+ *
+ * @param fallback Defaults to `0`
+ */let toNumber=(r,t)=>isNumber.isNumber(r)?r:r?parseFloat(r):t||0;
 
 exports["default"] = toNumber;
 exports.toNumber = toNumber;

package/toNumber.esm.js

@@ -1,6 +1,10 @@
 import { isNumber } from './isNumber.esm.js';
 import './getType.esm.js';
 
-let toNumber = (input, fallback) => isNumber(input) ? input : input ? parseFloat(input) : fallback || 0;
+/**
+ * @category cast
+ *
+ * @param fallback Defaults to `0`
+ */let toNumber=(r,t)=>isNumber(r)?r:r?parseFloat(r):t||0;
 
 export { toNumber as default, toNumber };

package/toRgba.cjs.js

@@ -2,13 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let toRgba = (hex, alpha = 1) => {
-    const r = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
-    if (r) {
-        return `rgba(${parseInt(r[1], 16)},${parseInt(r[2], 16)},${parseInt(r[3], 16)},${alpha})`;
-    }
-    return "";
-};
+/**
+ * @category colors
+ *
+ * @see `hex-rgb` package
+ */let toRgba=(e,t=1)=>{let a=/^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(e);return a?`rgba(${parseInt(a[1],16)},${parseInt(a[2],16)},${parseInt(a[3],16)},${t})`:""};
 
 exports["default"] = toRgba;
 exports.toRgba = toRgba;

package/toRgba.esm.js

@@ -1,9 +1,7 @@
-let toRgba = (hex, alpha = 1) => {
-    const r = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
-    if (r) {
-        return `rgba(${parseInt(r[1], 16)},${parseInt(r[2], 16)},${parseInt(r[3], 16)},${alpha})`;
-    }
-    return "";
-};
+/**
+ * @category colors
+ *
+ * @see `hex-rgb` package
+ */let toRgba=(e,t=1)=>{let a=/^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(e);return a?`rgba(${parseInt(a[1],16)},${parseInt(a[2],16)},${parseInt(a[3],16)},${t})`:""};
 
 export { toRgba as default, toRgba };

package/transformToUrlPathname.cjs.js

@@ -5,9 +5,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isString = require('./isString.cjs.js');
 require('./getType.cjs.js');
 
-let transformToUrlPathname = (toPathname) => isString.isString(toPathname)
-    ? `/${encodeURIComponent(toPathname.replace(/\s/g, "-").toLowerCase())}`
-    : "";
+/**
+ * Transform string in a URL pathname (relative URL)
+ *
+ * - adds an initial slash
+ * - encode the string
+ * - replaces whitespaces with dashes
+ *
+ * @category location
+ */let transformToUrlPathname=o=>isString.isString(o)?`/${encodeURIComponent(o.replace(/\s/g,"-").toLowerCase())}`:"";
 
 exports["default"] = transformToUrlPathname;
 exports.transformToUrlPathname = transformToUrlPathname;

package/transformToUrlPathname.esm.js

@@ -1,8 +1,14 @@
 import { isString } from './isString.esm.js';
 import './getType.esm.js';
 
-let transformToUrlPathname = (toPathname) => isString(toPathname)
-    ? `/${encodeURIComponent(toPathname.replace(/\s/g, "-").toLowerCase())}`
-    : "";
+/**
+ * Transform string in a URL pathname (relative URL)
+ *
+ * - adds an initial slash
+ * - encode the string
+ * - replaces whitespaces with dashes
+ *
+ * @category location
+ */let transformToUrlPathname=o=>isString(o)?`/${encodeURIComponent(o.replace(/\s/g,"-").toLowerCase())}`:"";
 
 export { transformToUrlPathname as default, transformToUrlPathname };

package/truncate.cjs.js

@@ -2,11 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let truncate = (input, length) => input
-    ? input.length > length
-        ? input.substring(0, length) + "..."
-        : input
-    : "";
+/**
+ * Truncate string
+ *
+ * @category text
+ */let truncate=(t,e)=>t?t.length>e?t.substring(0,e)+"...":t:"";
 
 exports["default"] = truncate;
 exports.truncate = truncate;

package/truncate.esm.js

@@ -1,7 +1,7 @@
-let truncate = (input, length) => input
-    ? input.length > length
-        ? input.substring(0, length) + "..."
-        : input
-    : "";
+/**
+ * Truncate string
+ *
+ * @category text
+ */let truncate=(t,e)=>t?t.length>e?t.substring(0,e)+"...":t:"";
 
 export { truncate as default, truncate };

package/tryUntil.cjs.js

@@ -2,20 +2,20 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let tryUntil = (test, timeout, interval, resolve, reject) => {
-    const timeWas = new Date();
-    const wait = setInterval(function () {
-        if (test()) {
-            clearInterval(wait);
-            resolve();
-        }
-        else if (new Date() - timeWas > timeout) {
-            clearInterval(wait);
-            if (reject)
-                reject();
-        }
-    }, interval);
-};
+/**
+ * @category function
+ * @category async
+ *
+ * @borrows [Javascript: Wait Until Something Happens or Timeout](https://levelup.gitconnected.com/javascript-wait-until-something-happens-or-timeout-82636839ea93)
+ *
+ * @param timeout in `ms`
+ * @param interval in `ms`
+ */let tryUntil=(t,e,l,n,r)=>{// return new Promise((resolve, reject) => {
+let a=new Date,c=setInterval(function(){t()?(// console.log("resolved after", new Date() - timeWas, "ms");
+clearInterval(c),n()):// @ts-expect-error ...
+new Date-a>e&&(// Timeout
+// console.log("rejected after", new Date() - timeWas, "ms");
+clearInterval(c),r&&r());},l);};// });
 
 exports["default"] = tryUntil;
 exports.tryUntil = tryUntil;

package/tryUntil.esm.js

@@ -1,16 +1,16 @@
-let tryUntil = (test, timeout, interval, resolve, reject) => {
-    const timeWas = new Date();
-    const wait = setInterval(function () {
-        if (test()) {
-            clearInterval(wait);
-            resolve();
-        }
-        else if (new Date() - timeWas > timeout) {
-            clearInterval(wait);
-            if (reject)
-                reject();
-        }
-    }, interval);
-};
+/**
+ * @category function
+ * @category async
+ *
+ * @borrows [Javascript: Wait Until Something Happens or Timeout](https://levelup.gitconnected.com/javascript-wait-until-something-happens-or-timeout-82636839ea93)
+ *
+ * @param timeout in `ms`
+ * @param interval in `ms`
+ */let tryUntil=(t,e,l,n,r)=>{// return new Promise((resolve, reject) => {
+let a=new Date,c=setInterval(function(){t()?(// console.log("resolved after", new Date() - timeWas, "ms");
+clearInterval(c),n()):// @ts-expect-error ...
+new Date-a>e&&(// Timeout
+// console.log("rejected after", new Date() - timeWas, "ms");
+clearInterval(c),r&&r());},l);};// });
 
 export { tryUntil as default, tryUntil };

package/uid.cjs.js

@@ -2,11 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let lastId = 0;
-let uid = (prefix = "id") => {
-    lastId++;
-    return `${prefix}-${lastId}`;
-};
+let e=0;/**
+ * Super basic UID increment-based generator
+ *
+ * @category uid
+ */let uid=(t="id")=>(e++,`${t}-${e}`);
 
 exports["default"] = uid;
 exports.uid = uid;

package/uid.esm.js

@@ -1,7 +1,7 @@
-let lastId = 0;
-let uid = (prefix = "id") => {
-    lastId++;
-    return `${prefix}-${lastId}`;
-};
+let e=0;/**
+ * Super basic UID increment-based generator
+ *
+ * @category uid
+ */let uid=(t="id")=>(e++,`${t}-${e}`);
 
 export { uid as default, uid };

package/updateLinkParams.cjs.js

@@ -12,11 +12,13 @@ require('./getUrlQueryParams.cjs.js');
 require('./isBrowser.cjs.js');
 require('./mergeUrlQueryParams.cjs.js');
 
-let updateLinkParams = ($anchor, newParams) => {
-    const href = updateUrlQueryParams.updateUrlQueryParams($anchor.href, newParams);
-    $anchor.href = href;
-    return href;
-};
+/**
+ * Update link `<a href="">` merging the given new query parameters.
+ * it returns the newly created `href` URL value
+ *
+ * @category location
+ * @pure
+ */let updateLinkParams=(e,a)=>{let t=updateUrlQueryParams.updateUrlQueryParams(e.href,a);return e.href=t,t};
 
 exports["default"] = updateLinkParams;
 exports.updateLinkParams = updateLinkParams;

package/updateLinkParams.esm.js

@@ -8,10 +8,12 @@ import './getUrlQueryParams.esm.js';
 import './isBrowser.esm.js';
 import './mergeUrlQueryParams.esm.js';
 
-let updateLinkParams = ($anchor, newParams) => {
-    const href = updateUrlQueryParams($anchor.href, newParams);
-    $anchor.href = href;
-    return href;
-};
+/**
+ * Update link `<a href="">` merging the given new query parameters.
+ * it returns the newly created `href` URL value
+ *
+ * @category location
+ * @pure
+ */let updateLinkParams=(e,a)=>{let t=updateUrlQueryParams(e.href,a);return e.href=t,t};
 
 export { updateLinkParams as default, updateLinkParams };

package/updateUrlQueryParams.cjs.js

@@ -11,13 +11,11 @@ require('./isNull.cjs.js');
 require('./isUndefined.cjs.js');
 require('./isBrowser.cjs.js');
 
-let updateUrlQueryParams = (url, newParams = {}) => {
-    const parts = url.split("?");
-    const allParams = parts[1]
-        ? mergeUrlQueryParams.mergeUrlQueryParams(getUrlQueryParams.getUrlQueryParams(url), newParams)
-        : newParams;
-    return parts[0] + buildUrlQueryString.buildUrlQueryString(allParams);
-};
+/**
+ * Update a URL string query parameters merging the given new query parameters
+ *
+ * @category location
+ */let updateUrlQueryParams=(a,m={})=>{let l=a.split("?"),u=l[1]?mergeUrlQueryParams.mergeUrlQueryParams(getUrlQueryParams.getUrlQueryParams(a),m):m;return l[0]+buildUrlQueryString.buildUrlQueryString(u)};
 
 exports["default"] = updateUrlQueryParams;
 exports.updateUrlQueryParams = updateUrlQueryParams;

package/updateUrlQueryParams.esm.js

@@ -7,12 +7,10 @@ import './isNull.esm.js';
 import './isUndefined.esm.js';
 import './isBrowser.esm.js';
 
-let updateUrlQueryParams = (url, newParams = {}) => {
-    const parts = url.split("?");
-    const allParams = parts[1]
-        ? mergeUrlQueryParams(getUrlQueryParams(url), newParams)
-        : newParams;
-    return parts[0] + buildUrlQueryString(allParams);
-};
+/**
+ * Update a URL string query parameters merging the given new query parameters
+ *
+ * @category location
+ */let updateUrlQueryParams=(a,m={})=>{let l=a.split("?"),u=l[1]?mergeUrlQueryParams(getUrlQueryParams(a),m):m;return l[0]+buildUrlQueryString(u)};
 
 export { updateUrlQueryParams as default, updateUrlQueryParams };

package/uppercase.cjs.js

@@ -2,7 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let uppercase = (str) => (str || "").toUpperCase();
+/**
+ * Replacement for native `toUpperCase` tyescript ready (type narrowing ready)
+ *
+ * @category native
+ * @category text
+ */let uppercase=e=>(e||"").toUpperCase();
 
 exports["default"] = uppercase;
 exports.uppercase = uppercase;

package/uppercase.d.ts

@@ -1,2 +1,2 @@
-export declare let uppercase: <T extends string>(str?: T | null | undefined) => Uppercase<T>;
+export declare let uppercase: <T extends string>(str?: null | T) => Uppercase<T>;
 export default uppercase;

package/uppercase.esm.js

@@ -1,3 +1,8 @@
-let uppercase = (str) => (str || "").toUpperCase();
+/**
+ * Replacement for native `toUpperCase` tyescript ready (type narrowing ready)
+ *
+ * @category native
+ * @category text
+ */let uppercase=e=>(e||"").toUpperCase();
 
 export { uppercase as default, uppercase };