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

package/getUrlHashPathname.cjs.js

@@ -2,7 +2,13 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getUrlHashPathname=(a="")=>(a||location.hash).split("?")[0].replace(/^#\//,"");
+/**
+ * It returns the "pathname" cleaned up from the `#` and the initial slashes
+ * extracting it from the given `hash` string or, if not provided, failling
+ * back reading the `location.hash`
+ *
+ * @category location
+ */let getUrlHashPathname=(a="")=>(a||location.hash).split("?")[0].replace(/^#\//,"");
 
 exports["default"] = getUrlHashPathname;
 exports.getUrlHashPathname = getUrlHashPathname;

package/getUrlHashPathname.esm.js

@@ -1,3 +1,9 @@
-let getUrlHashPathname=(a="")=>(a||location.hash).split("?")[0].replace(/^#\//,"");
+/**
+ * It returns the "pathname" cleaned up from the `#` and the initial slashes
+ * extracting it from the given `hash` string or, if not provided, failling
+ * back reading the `location.hash`
+ *
+ * @category location
+ */let getUrlHashPathname=(a="")=>(a||location.hash).split("?")[0].replace(/^#\//,"");
 
 export { getUrlHashPathname as default, getUrlHashPathname };

package/getUrlPathnameParts.cjs.js

@@ -4,7 +4,16 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var isBrowser = require('./isBrowser.cjs.js');
 
-let getUrlPathnameParts=(e="")=>(e||(isBrowser.isBrowser?location.pathname:"")).replace(/^\//,"").split("/").filter(Boolean);
+/**
+ * Get pathname parts
+ *
+ * First clean the pathname from the first slash if any then split the pathname
+ * in parts,
+ * Given a pathname like: `"/en/{prefix}/{collection}/{slug}"` we obtain
+ * `[locale, prefix, collection, slug]`
+ *
+ * @category location
+ */let getUrlPathnameParts=(e="")=>(e||(isBrowser.isBrowser?location.pathname:"")).replace(/^\//,"").split("/").filter(Boolean);
 
 exports["default"] = getUrlPathnameParts;
 exports.getUrlPathnameParts = getUrlPathnameParts;

package/getUrlPathnameParts.esm.js

@@ -1,5 +1,14 @@
 import { isBrowser } from './isBrowser.esm.js';
 
-let getUrlPathnameParts=(e="")=>(e||(isBrowser?location.pathname:"")).replace(/^\//,"").split("/").filter(Boolean);
+/**
+ * Get pathname parts
+ *
+ * First clean the pathname from the first slash if any then split the pathname
+ * in parts,
+ * Given a pathname like: `"/en/{prefix}/{collection}/{slug}"` we obtain
+ * `[locale, prefix, collection, slug]`
+ *
+ * @category location
+ */let getUrlPathnameParts=(e="")=>(e||(isBrowser?location.pathname:"")).replace(/^\//,"").split("/").filter(Boolean);
 
 export { getUrlPathnameParts as default, getUrlPathnameParts };

package/getUrlQueryParams.cjs.js

@@ -4,7 +4,18 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var isBrowser = require('./isBrowser.cjs.js');
 
-let getUrlQueryParams=r=>{let t={},a=r?r.split("?")?.[1]:isBrowser.isBrowser?location.search.substring(1):"";if(!a)return {};try{let e=`{"${a.replace(/&/g,'","').replace(/=/g,'":"')}"}`;t=JSON.parse(e,(e,r)=>""===e?r:decodeURIComponent(r));}catch(e){}return t};
+/**
+ * Get parsed query parameters as object dictionary (from URL or given query string)
+ *
+ * @category location
+ * @param url A URL which contains a  `?`, e.g. `?myparam=x` or `https://a.com?myparams=x`.
+ * If not provided it defaults reading the current URL query string with
+ * `location.search`. Through this argument you can use this same function to
+ * parse, for instance, the query params of the `href` of a `<a href="...">` HTML tag.
+ *
+ */let getUrlQueryParams=r=>{let t={},a=r?r.split("?")?.[1]:isBrowser.isBrowser?location.search.substring(1):"";if(!a)return {};try{// @see https://stackoverflow.com/a/8649003/1938970
+let e=`{"${a.replace(/&/g,'","').replace(/=/g,'":"')}"}`;t=JSON.parse(e,(e,r)=>""===e?r:decodeURIComponent(r));}catch(e){}// do nothing or warn on process.env["NODE_ENV"] === "development"
+return t};
 
 exports["default"] = getUrlQueryParams;
 exports.getUrlQueryParams = getUrlQueryParams;

package/getUrlQueryParams.esm.js

@@ -1,5 +1,16 @@
 import { isBrowser } from './isBrowser.esm.js';
 
-let getUrlQueryParams=r=>{let t={},a=r?r.split("?")?.[1]:isBrowser?location.search.substring(1):"";if(!a)return {};try{let e=`{"${a.replace(/&/g,'","').replace(/=/g,'":"')}"}`;t=JSON.parse(e,(e,r)=>""===e?r:decodeURIComponent(r));}catch(e){}return t};
+/**
+ * Get parsed query parameters as object dictionary (from URL or given query string)
+ *
+ * @category location
+ * @param url A URL which contains a  `?`, e.g. `?myparam=x` or `https://a.com?myparams=x`.
+ * If not provided it defaults reading the current URL query string with
+ * `location.search`. Through this argument you can use this same function to
+ * parse, for instance, the query params of the `href` of a `<a href="...">` HTML tag.
+ *
+ */let getUrlQueryParams=r=>{let t={},a=r?r.split("?")?.[1]:isBrowser?location.search.substring(1):"";if(!a)return {};try{// @see https://stackoverflow.com/a/8649003/1938970
+let e=`{"${a.replace(/&/g,'","').replace(/=/g,'":"')}"}`;t=JSON.parse(e,(e,r)=>""===e?r:decodeURIComponent(r));}catch(e){}// do nothing or warn on process.env["NODE_ENV"] === "development"
+return t};
 
 export { getUrlQueryParams as default, getUrlQueryParams };

package/hashAny.cjs.js

@@ -5,7 +5,36 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isUndefined = require('./isUndefined.cjs.js');
 require('./getType.cjs.js');
 
-let e=Object,r=new WeakMap,s=0;const hashAny=n=>{let o,f;let i=typeof n,a=n&&n.constructor,h=a==Date;if(e(n)!==n||h||a==RegExp)o=h?n.toJSON():"symbol"==i?n.toString():"string"==i?JSON.stringify(n):""+n;else {if(o=r.get(n))return o;if(o=++s+"~",r.set(n,o),a==Array){for(f=0,o="@";f<n.length;f++)o+=hashAny(n[f])+",";r.set(n,o);}if(a==e){o="#";let s=e.keys(n).sort();for(;!isUndefined.isUndefined(f=s.pop());)isUndefined.isUndefined(n[f])||(o+=f+":"+hashAny(n[f])+",");r.set(n,o);}}return o};
+/* eslint-disable @typescript-eslint/no-explicit-any */// import { OBJECT, isUndefined } from './shared'
+let e=Object,// use WeakMap to store the object->key mapping
+// so the objects can be garbage collected.
+// WeakMap uses a hashtable under the hood, so the lookup
+// complexity is almost O(1).
+r=new WeakMap,// counter of the key
+s=0;/**
+ * A stable hash implementation that supports:
+ * - Fast and ensures unique hash properties
+ * - Handles unserializable values
+ * - Handles object key ordering
+ * - Generates short results
+ *
+ * This is not a serialization function, and the result is not guaranteed to be
+ * parsable.
+ *
+ * @borrows [`swr`'s `stableHash`](https://github.com/vercel/swr/blob/main/src/_internal/utils/shared.ts)
+ *
+ * That is not exported by the package, the following is not possible:
+ * ```js
+ * import { stableHash } from "swr/_internal/dist";
+ * ```
+ */const hashAny=n=>{let o,f;let i=typeof n,a=n&&n.constructor,h=a==Date;if(e(n)!==n||h||a==RegExp)o=h?n.toJSON():"symbol"==i?n.toString():"string"==i?JSON.stringify(n):""+n;else {if(// Object/function, not null/date/regexp. Use WeakMap to store the id first.
+// If it's already hashed, directly return the result.
+o=r.get(n))return o;if(// Store the hash first for circular reference detection before entering the
+// recursive `hashAny` calls.
+// For other objects like set and map, we use this id directly as the hash.
+o=++s+"~",r.set(n,o),a==Array){for(f=0,// Array.
+o="@";f<n.length;f++)o+=hashAny(n[f])+",";r.set(n,o);}if(a==e){// Object, sort keys.
+o="#";let s=e.keys(n).sort();for(;!isUndefined.isUndefined(f=s.pop());)isUndefined.isUndefined(n[f])||(o+=f+":"+hashAny(n[f])+",");r.set(n,o);}}return o};
 
 exports["default"] = hashAny;
 exports.hashAny = hashAny;

package/hashAny.esm.js

@@ -1,6 +1,35 @@
 import { isUndefined } from './isUndefined.esm.js';
 import './getType.esm.js';
 
-let e=Object,r=new WeakMap,s=0;const hashAny=n=>{let o,f;let i=typeof n,a=n&&n.constructor,h=a==Date;if(e(n)!==n||h||a==RegExp)o=h?n.toJSON():"symbol"==i?n.toString():"string"==i?JSON.stringify(n):""+n;else {if(o=r.get(n))return o;if(o=++s+"~",r.set(n,o),a==Array){for(f=0,o="@";f<n.length;f++)o+=hashAny(n[f])+",";r.set(n,o);}if(a==e){o="#";let s=e.keys(n).sort();for(;!isUndefined(f=s.pop());)isUndefined(n[f])||(o+=f+":"+hashAny(n[f])+",");r.set(n,o);}}return o};
+/* eslint-disable @typescript-eslint/no-explicit-any */// import { OBJECT, isUndefined } from './shared'
+let e=Object,// use WeakMap to store the object->key mapping
+// so the objects can be garbage collected.
+// WeakMap uses a hashtable under the hood, so the lookup
+// complexity is almost O(1).
+r=new WeakMap,// counter of the key
+s=0;/**
+ * A stable hash implementation that supports:
+ * - Fast and ensures unique hash properties
+ * - Handles unserializable values
+ * - Handles object key ordering
+ * - Generates short results
+ *
+ * This is not a serialization function, and the result is not guaranteed to be
+ * parsable.
+ *
+ * @borrows [`swr`'s `stableHash`](https://github.com/vercel/swr/blob/main/src/_internal/utils/shared.ts)
+ *
+ * That is not exported by the package, the following is not possible:
+ * ```js
+ * import { stableHash } from "swr/_internal/dist";
+ * ```
+ */const hashAny=n=>{let o,f;let i=typeof n,a=n&&n.constructor,h=a==Date;if(e(n)!==n||h||a==RegExp)o=h?n.toJSON():"symbol"==i?n.toString():"string"==i?JSON.stringify(n):""+n;else {if(// Object/function, not null/date/regexp. Use WeakMap to store the id first.
+// If it's already hashed, directly return the result.
+o=r.get(n))return o;if(// Store the hash first for circular reference detection before entering the
+// recursive `hashAny` calls.
+// For other objects like set and map, we use this id directly as the hash.
+o=++s+"~",r.set(n,o),a==Array){for(f=0,// Array.
+o="@";f<n.length;f++)o+=hashAny(n[f])+",";r.set(n,o);}if(a==e){// Object, sort keys.
+o="#";let s=e.keys(n).sort();for(;!isUndefined(f=s.pop());)isUndefined(n[f])||(o+=f+":"+hashAny(n[f])+",");r.set(n,o);}}return o};
 
 export { hashAny as default, hashAny };

package/imgEmptyPixel.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let imgEmptyPixel="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=";
+/**
+ * Empty img pixel as a string to inline
+ *
+ * @category img
+ */let imgEmptyPixel="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=";
 
 exports["default"] = imgEmptyPixel;
 exports.imgEmptyPixel = imgEmptyPixel;

package/imgEmptyPixel.esm.js

@@ -1,3 +1,7 @@
-let imgEmptyPixel="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=";
+/**
+ * Empty img pixel as a string to inline
+ *
+ * @category img
+ */let imgEmptyPixel="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=";
 
 export { imgEmptyPixel as default, imgEmptyPixel };

package/invariant.cjs.js

@@ -2,7 +2,23 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let invariant=(e,t,r,n)=>{if("development"===process.env.NODE_ENV){if(e)return;let o="function"==typeof t?t():t,i="";throw r&&n?i=`[${r}:${n}] `:r&&(i=`[${r}] `),Error(i+o)}};
+/**
+ * FIXME: invariant calls do not get tree shaked in minified output of projects
+ * using it. Let's not use it internally and not export it from `@koine/utils`
+ * until we find a tree-shakeable way of doing this. For now just wrapping
+ * the logging code into `if (process.env["NODE_ENV"] === "development") {}`
+ * works better despite it is more verbose.
+ *
+ * @resources
+ * - https://github.com/alexreardon/tiny-invariant
+ * - https://github.com/zertosh/invariant
+ * - https://stackoverflow.com/q/39055159/1938970
+ *
+ * @param condition The condition that, if `true` will throw the error during development
+ * @param message A string or a function that returns a string
+ * @param lib The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ * @param prefix The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ */let invariant=(e,t,r,n)=>{if("development"===process.env.NODE_ENV){if(e)return;let o="function"==typeof t?t():t,i="";throw r&&n?i=`[${r}:${n}] `:r&&(i=`[${r}] `),Error(i+o)}};
 
 exports["default"] = invariant;
 exports.invariant = invariant;

package/invariant.esm.js

@@ -1,3 +1,19 @@
-let invariant=(e,t,r,n)=>{if("development"===process.env.NODE_ENV){if(e)return;let o="function"==typeof t?t():t,i="";throw r&&n?i=`[${r}:${n}] `:r&&(i=`[${r}] `),Error(i+o)}};
+/**
+ * FIXME: invariant calls do not get tree shaked in minified output of projects
+ * using it. Let's not use it internally and not export it from `@koine/utils`
+ * until we find a tree-shakeable way of doing this. For now just wrapping
+ * the logging code into `if (process.env["NODE_ENV"] === "development") {}`
+ * works better despite it is more verbose.
+ *
+ * @resources
+ * - https://github.com/alexreardon/tiny-invariant
+ * - https://github.com/zertosh/invariant
+ * - https://stackoverflow.com/q/39055159/1938970
+ *
+ * @param condition The condition that, if `true` will throw the error during development
+ * @param message A string or a function that returns a string
+ * @param lib The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ * @param prefix The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ */let invariant=(e,t,r,n)=>{if("development"===process.env.NODE_ENV){if(e)return;let o="function"==typeof t?t():t,i="";throw r&&n?i=`[${r}:${n}] `:r&&(i=`[${r}] `),Error(i+o)}};
 
 export { invariant as default, invariant };

package/isAbsoluteUrl.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let t=/^(?:[a-z+]+:)?\/\//i;let isAbsoluteUrl=e=>t.test(e);
+let t=/^(?:[a-z+]+:)?\/\//i;/**
+ * @borrows [SO's answer](https://stackoverflow.com/a/19709846/1938970)
+ *
+ * @category is
+ */let isAbsoluteUrl=e=>t.test(e);
 
 exports["default"] = isAbsoluteUrl;
 exports.isAbsoluteUrl = isAbsoluteUrl;

package/isAbsoluteUrl.esm.js

@@ -1,3 +1,7 @@
-let t=/^(?:[a-z+]+:)?\/\//i;let isAbsoluteUrl=e=>t.test(e);
+let t=/^(?:[a-z+]+:)?\/\//i;/**
+ * @borrows [SO's answer](https://stackoverflow.com/a/19709846/1938970)
+ *
+ * @category is
+ */let isAbsoluteUrl=e=>t.test(e);
 
 export { isAbsoluteUrl as default, isAbsoluteUrl };

package/isAnyObject.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isAnyObject=t=>"Object"===getType.getType(t);
+/**
+ * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
+ *
+ * @category is
+ */let isAnyObject=t=>"Object"===getType.getType(t);
 
 exports["default"] = isAnyObject;
 exports.isAnyObject = isAnyObject;

package/isAnyObject.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isAnyObject=t=>"Object"===getType(t);
+/**
+ * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
+ *
+ * @category is
+ */let isAnyObject=t=>"Object"===getType(t);
 
 export { isAnyObject as default, isAnyObject };

package/isArray.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isArray=e=>"Array"===getType.getType(e);
+/**
+ * Returns whether the payload is an array
+ *
+ * @category is
+ */let isArray=e=>"Array"===getType.getType(e);
 
 exports["default"] = isArray;
 exports.isArray = isArray;

package/isArray.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isArray=e=>"Array"===getType(e);
+/**
+ * Returns whether the payload is an array
+ *
+ * @category is
+ */let isArray=e=>"Array"===getType(e);
 
 export { isArray as default, isArray };

package/isBlob.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isBlob=e=>"Blob"===getType.getType(e);
+/**
+ * Returns whether the payload is a Blob
+ *
+ * @category is
+ */let isBlob=e=>"Blob"===getType.getType(e);
 
 exports["default"] = isBlob;
 exports.isBlob = isBlob;

package/isBlob.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isBlob=e=>"Blob"===getType(e);
+/**
+ * Returns whether the payload is a Blob
+ *
+ * @category is
+ */let isBlob=e=>"Blob"===getType(e);
 
 export { isBlob as default, isBlob };

package/isBoolean.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isBoolean=e=>"Boolean"===getType.getType(e);
+/**
+ * Returns whether the payload is a boolean
+ *
+ * @category is
+ */let isBoolean=e=>"Boolean"===getType.getType(e);
 
 exports["default"] = isBoolean;
 exports.isBoolean = isBoolean;

package/isBoolean.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isBoolean=e=>"Boolean"===getType(e);
+/**
+ * Returns whether the payload is a boolean
+ *
+ * @category is
+ */let isBoolean=e=>"Boolean"===getType(e);
 
 export { isBoolean as default, isBoolean };

package/isBrowser.cjs.js

@@ -2,7 +2,10 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let isBrowser="undefined"!=typeof window;
+/**
+ * @category ssr
+ * @category is
+ */let isBrowser="undefined"!=typeof window;
 
 exports["default"] = isBrowser;
 exports.isBrowser = isBrowser;

package/isBrowser.esm.js

@@ -1,3 +1,6 @@
-let isBrowser="undefined"!=typeof window;
+/**
+ * @category ssr
+ * @category is
+ */let isBrowser="undefined"!=typeof window;
 
 export { isBrowser as default, isBrowser };

package/isBrowserNow.cjs.js

@@ -5,7 +5,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isUndefined = require('./isUndefined.cjs.js');
 require('./getType.cjs.js');
 
-let isBrowserNow=()=>!isUndefined.isUndefined(window);
+/**
+ * @category ssr
+ * @category is
+ */let isBrowserNow=()=>!isUndefined.isUndefined(window);
 
 exports["default"] = isBrowserNow;
 exports.isBrowserNow = isBrowserNow;

package/isBrowserNow.esm.js

@@ -1,6 +1,9 @@
 import { isUndefined } from './isUndefined.esm.js';
 import './getType.esm.js';
 
-let isBrowserNow=()=>!isUndefined(window);
+/**
+ * @category ssr
+ * @category is
+ */let isBrowserNow=()=>!isUndefined(window);
 
 export { isBrowserNow as default, isBrowserNow };

package/isDate.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isDate=t=>"Date"===getType.getType(t)&&!isNaN(t);
+/**
+ * Returns whether the payload is a Date, and that the date is valid
+ *
+ * @category is
+ */let isDate=t=>"Date"===getType.getType(t)&&!isNaN(t);
 
 exports["default"] = isDate;
 exports.isDate = isDate;

package/isDate.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isDate=t=>"Date"===getType(t)&&!isNaN(t);
+/**
+ * Returns whether the payload is a Date, and that the date is valid
+ *
+ * @category is
+ */let isDate=t=>"Date"===getType(t)&&!isNaN(t);
 
 export { isDate as default, isDate };

package/isEmptyArray.cjs.js

@@ -5,7 +5,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isArray = require('./isArray.cjs.js');
 require('./getType.cjs.js');
 
-let isEmptyArray=t=>isArray.isArray(t)&&0===t.length;
+/**
+ * Returns whether the payload is a an empty array
+ *
+ * @category is
+ */let isEmptyArray=t=>isArray.isArray(t)&&0===t.length;
 
 exports["default"] = isEmptyArray;
 exports.isEmptyArray = isEmptyArray;

package/isEmptyArray.esm.js

@@ -1,6 +1,10 @@
 import { isArray } from './isArray.esm.js';
 import './getType.esm.js';
 
-let isEmptyArray=t=>isArray(t)&&0===t.length;
+/**
+ * Returns whether the payload is a an empty array
+ *
+ * @category is
+ */let isEmptyArray=t=>isArray(t)&&0===t.length;
 
 export { isEmptyArray as default, isEmptyArray };

package/isEmptyObject.cjs.js

@@ -5,7 +5,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isPlainObject = require('./isPlainObject.cjs.js');
 require('./getType.cjs.js');
 
-let isEmptyObject=e=>isPlainObject.isPlainObject(e)&&0===Object.keys(e).length;
+/**
+ * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
+ *
+ * @category is
+ */let isEmptyObject=e=>isPlainObject.isPlainObject(e)&&0===Object.keys(e).length;
 
 exports["default"] = isEmptyObject;
 exports.isEmptyObject = isEmptyObject;

package/isEmptyObject.esm.js

@@ -1,6 +1,10 @@
 import { isPlainObject } from './isPlainObject.esm.js';
 import './getType.esm.js';
 
-let isEmptyObject=e=>isPlainObject(e)&&0===Object.keys(e).length;
+/**
+ * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
+ *
+ * @category is
+ */let isEmptyObject=e=>isPlainObject(e)&&0===Object.keys(e).length;
 
 export { isEmptyObject as default, isEmptyObject };

package/isEmptyString.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let isEmptyString=t=>""===t;
+/**
+ * Returns whether the payload is ''
+ *
+ * @category is
+ */let isEmptyString=t=>""===t;
 
 exports["default"] = isEmptyString;
 exports.isEmptyString = isEmptyString;

package/isEmptyString.esm.js

@@ -1,3 +1,7 @@
-let isEmptyString=t=>""===t;
+/**
+ * Returns whether the payload is ''
+ *
+ * @category is
+ */let isEmptyString=t=>""===t;
 
 export { isEmptyString as default, isEmptyString };

package/isError.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isError=o=>"Error"===getType.getType(o);
+/**
+ * Returns whether the payload is an Error
+ *
+ * @category is
+ */let isError=o=>"Error"===getType.getType(o);
 
 exports["default"] = isError;
 exports.isError = isError;

package/isError.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isError=o=>"Error"===getType(o);
+/**
+ * Returns whether the payload is an Error
+ *
+ * @category is
+ */let isError=o=>"Error"===getType(o);
 
 export { isError as default, isError };

package/isExternalUrl.cjs.js

@@ -4,7 +4,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var isBrowser = require('./isBrowser.cjs.js');
 
-let isExternalUrl=(r,t)=>{let l=/https?:\/\/((?:[\w\d-]+\.)+[\w\d]{2,})/i,o=l.exec(r);return !!o&&(!(t=t||isBrowser.isBrowser?location.href:"")||l.exec(t)?.[1]!==o[1])};
+/**
+ * Is external url compared to the given current URL (if not provided it falls
+ * back to `location.href`)
+ *
+ * @category location
+ *
+ */let isExternalUrl=(r,t)=>{let l=/https?:\/\/((?:[\w\d-]+\.)+[\w\d]{2,})/i,o=l.exec(r);return(// if no matches are found it means we either have an invalid URL, a relative
+// URL or a hash link, and those are not considered externals
+!!o&&(!(t=t||isBrowser.isBrowser?location.href:"")||l.exec(t)?.[1]!==o[1]))};
 
 exports["default"] = isExternalUrl;
 exports.isExternalUrl = isExternalUrl;

package/isExternalUrl.esm.js

@@ -1,5 +1,13 @@
 import { isBrowser } from './isBrowser.esm.js';
 
-let isExternalUrl=(r,t)=>{let l=/https?:\/\/((?:[\w\d-]+\.)+[\w\d]{2,})/i,o=l.exec(r);return !!o&&(!(t=t||isBrowser?location.href:"")||l.exec(t)?.[1]!==o[1])};
+/**
+ * Is external url compared to the given current URL (if not provided it falls
+ * back to `location.href`)
+ *
+ * @category location
+ *
+ */let isExternalUrl=(r,t)=>{let l=/https?:\/\/((?:[\w\d-]+\.)+[\w\d]{2,})/i,o=l.exec(r);return(// if no matches are found it means we either have an invalid URL, a relative
+// URL or a hash link, and those are not considered externals
+!!o&&(!(t=t||isBrowser?location.href:"")||l.exec(t)?.[1]!==o[1]))};
 
 export { isExternalUrl as default, isExternalUrl };

package/isFile.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isFile=i=>"File"===getType.getType(i);
+/**
+ * Returns whether the payload is a File
+ *
+ * @category is
+ */let isFile=i=>"File"===getType.getType(i);
 
 exports["default"] = isFile;
 exports.isFile = isFile;

package/isFile.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isFile=i=>"File"===getType(i);
+/**
+ * Returns whether the payload is a File
+ *
+ * @category is
+ */let isFile=i=>"File"===getType(i);
 
 export { isFile as default, isFile };

package/isFloat.cjs.js

@@ -5,7 +5,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isNumber = require('./isNumber.cjs.js');
 require('./getType.cjs.js');
 
-let isFloat=o=>isNumber.isNumber(o)&&o%1!=0;
+/**
+ * Returns whether the payload is a float number
+ *
+ * @category is
+ */let isFloat=o=>isNumber.isNumber(o)&&o%1!=0;
 
 exports["default"] = isFloat;
 exports.isFloat = isFloat;