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

package/toRgba.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-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})`:""};
+/**
+ * @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,3 +1,7 @@
-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})`:""};
+/**
+ * @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,7 +5,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isString = require('./isString.cjs.js');
 require('./getType.cjs.js');
 
-let transformToUrlPathname=o=>isString.isString(o)?`/${encodeURIComponent(o.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,6 +1,14 @@
 import { isString } from './isString.esm.js';
 import './getType.esm.js';
 
-let transformToUrlPathname=o=>isString(o)?`/${encodeURIComponent(o.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,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let truncate=(t,e)=>t?t.length>e?t.substring(0,e)+"...":t:"";
+/**
+ * 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,3 +1,7 @@
-let truncate=(t,e)=>t?t.length>e?t.substring(0,e)+"...":t:"";
+/**
+ * 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,7 +2,20 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let tryUntil=(t,e,l,n,r)=>{let a=new Date,c=setInterval(function(){t()?(clearInterval(c),n()):new Date-a>e&&(clearInterval(c),r&&r());},l);};
+/**
+ * @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,3 +1,16 @@
-let tryUntil=(t,e,l,n,r)=>{let a=new Date,c=setInterval(function(){t()?(clearInterval(c),n()):new Date-a>e&&(clearInterval(c),r&&r());},l);};
+/**
+ * @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,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let e=0;let uid=(t="id")=>(e++,`${t}-${e}`);
+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,3 +1,7 @@
-let e=0;let uid=(t="id")=>(e++,`${t}-${e}`);
+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,7 +12,13 @@ require('./getUrlQueryParams.cjs.js');
 require('./isBrowser.cjs.js');
 require('./mergeUrlQueryParams.cjs.js');
 
-let updateLinkParams=(e,a)=>{let t=updateUrlQueryParams.updateUrlQueryParams(e.href,a);return e.href=t,t};
+/**
+ * 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,6 +8,12 @@ import './getUrlQueryParams.esm.js';
 import './isBrowser.esm.js';
 import './mergeUrlQueryParams.esm.js';
 
-let updateLinkParams=(e,a)=>{let t=updateUrlQueryParams(e.href,a);return e.href=t,t};
+/**
+ * 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,7 +11,11 @@ require('./isNull.cjs.js');
 require('./isUndefined.cjs.js');
 require('./isBrowser.cjs.js');
 
-let updateUrlQueryParams=(a,m={})=>{let l=a.split("?"),u=l[1]?mergeUrlQueryParams.mergeUrlQueryParams(getUrlQueryParams.getUrlQueryParams(a),m):m;return l[0]+buildUrlQueryString.buildUrlQueryString(u)};
+/**
+ * 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,6 +7,10 @@ import './isNull.esm.js';
 import './isUndefined.esm.js';
 import './isBrowser.esm.js';
 
-let updateUrlQueryParams=(a,m={})=>{let l=a.split("?"),u=l[1]?mergeUrlQueryParams(getUrlQueryParams(a),m):m;return l[0]+buildUrlQueryString(u)};
+/**
+ * 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=e=>(e||"").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.esm.js

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

package/uuid.cjs.js

@@ -2,7 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let uuid=()=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,x=>{let t=16*Math.random()|0;return ("x"==x?t:3&t|8).toString(16)});
+/**
+ * Uuid, tiny custom helper instead of node's uuid/v4
+ *
+ * @category uid
+ * @see https://stackoverflow.com/a/2117523/1938970
+ */let uuid=()=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,x=>{let t=16*Math.random()|0;return ("x"==x?t:3&t|8).toString(16)});
 
 exports["default"] = uuid;
 exports.uuid = uuid;

package/uuid.esm.js

@@ -1,3 +1,8 @@
-let uuid=()=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,x=>{let t=16*Math.random()|0;return ("x"==x?t:3&t|8).toString(16)});
+/**
+ * Uuid, tiny custom helper instead of node's uuid/v4
+ *
+ * @category uid
+ * @see https://stackoverflow.com/a/2117523/1938970
+ */let uuid=()=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,x=>{let t=16*Math.random()|0;return ("x"==x?t:3&t|8).toString(16)});
 
 export { uuid as default, uuid };

package/uuidNumeric.cjs.js

@@ -2,7 +2,10 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let uuidNumeric=()=>new Date().valueOf();
+/**
+ * @category uid
+ * @see https://stackoverflow.com/a/18048162/1938970
+ */let uuidNumeric=()=>new Date().valueOf();
 
 exports["default"] = uuidNumeric;
 exports.uuidNumeric = uuidNumeric;

package/uuidNumeric.esm.js

@@ -1,3 +1,6 @@
-let uuidNumeric=()=>new Date().valueOf();
+/**
+ * @category uid
+ * @see https://stackoverflow.com/a/18048162/1938970
+ */let uuidNumeric=()=>new Date().valueOf();
 
 export { uuidNumeric as default, uuidNumeric };

package/wait.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let wait=e=>new Promise(t=>setTimeout(t,e));
+/**
+ * A promisified `setTimeout`
+ *
+ * @category async
+ */let wait=e=>new Promise(t=>setTimeout(t,e));
 
 exports["default"] = wait;
 exports.wait = wait;

package/wait.esm.js

@@ -1,3 +1,7 @@
-let wait=e=>new Promise(t=>setTimeout(t,e));
+/**
+ * A promisified `setTimeout`
+ *
+ * @category async
+ */let wait=e=>new Promise(t=>setTimeout(t,e));
 
 export { wait as default, wait };