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

package/isFloat.esm.js

@@ -1,6 +1,10 @@
 import { isNumber } from './isNumber.esm.js';
 import './getType.esm.js';
 
-let isFloat=o=>isNumber(o)&&o%1!=0;
+/**
+ * Returns whether the payload is a float number
+ *
+ * @category is
+ */let isFloat=o=>isNumber(o)&&o%1!=0;
 
 export { isFloat as default, isFloat };

package/isFormData.cjs.js

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

package/isFormData.esm.js

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

package/isFullArray.cjs.js

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

package/isFullArray.esm.js

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

package/isFullObject.cjs.js

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

package/isFullObject.esm.js

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

package/isFullString.cjs.js

@@ -5,7 +5,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isString = require('./isString.cjs.js');
 require('./getType.cjs.js');
 
-let isFullString=i=>isString.isString(i)&&""!==i;
+/**
+ * Returns whether the payload is a string, BUT returns false for ''
+ *
+ * @category is
+ */let isFullString=i=>isString.isString(i)&&""!==i;
 
 exports["default"] = isFullString;
 exports.isFullString = isFullString;

package/isFullString.esm.js

@@ -1,6 +1,10 @@
 import { isString } from './isString.esm.js';
 import './getType.esm.js';
 
-let isFullString=i=>isString(i)&&""!==i;
+/**
+ * Returns whether the payload is a string, BUT returns false for ''
+ *
+ * @category is
+ */let isFullString=i=>isString(i)&&""!==i;
 
 export { isFullString as default, isFullString };

package/isFunction.cjs.js

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

package/isFunction.esm.js

@@ -1,3 +1,7 @@
-let isFunction=t=>"function"==typeof t;
+/**
+ * Returns whether the payload is a function (regular or async)
+ *
+ * @category is
+ */let isFunction=t=>"function"==typeof t;
 
 export { isFunction as default, isFunction };

package/isInt.cjs.js

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

package/isInt.esm.js

@@ -1,6 +1,10 @@
 import { isNumber } from './isNumber.esm.js';
 import './getType.esm.js';
 
-let isInt=e=>isNumber(e)&&e%1==0;
+/**
+ * Returns whether the payload is an integer number
+ *
+ * @category is
+ */let isInt=e=>isNumber(e)&&e%1==0;
 
 export { isInt as default, isInt };

package/isMap.cjs.js

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

package/isMap.esm.js

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

package/isNaNValue.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isNaNValue=N=>"Number"===getType.getType(N)&&isNaN(N);
+/**
+ * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
+ *
+ * @category is
+ */let isNaNValue=N=>"Number"===getType.getType(N)&&isNaN(N);
 
 exports["default"] = isNaNValue;
 exports.isNaNValue = isNaNValue;

package/isNaNValue.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isNaNValue=N=>"Number"===getType(N)&&isNaN(N);
+/**
+ * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
+ *
+ * @category is
+ */let isNaNValue=N=>"Number"===getType(N)&&isNaN(N);
 
 export { isNaNValue as default, isNaNValue };

package/isNegativeNumber.cjs.js

@@ -5,7 +5,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isNumber = require('./isNumber.cjs.js');
 require('./getType.cjs.js');
 
-let isNegativeNumber=r=>isNumber.isNumber(r)&&r<0;
+/**
+ * Returns whether the payload is a negative number (but not 0)
+ *
+ * @category is
+ */let isNegativeNumber=r=>isNumber.isNumber(r)&&r<0;
 
 exports["default"] = isNegativeNumber;
 exports.isNegativeNumber = isNegativeNumber;

package/isNegativeNumber.esm.js

@@ -1,6 +1,10 @@
 import { isNumber } from './isNumber.esm.js';
 import './getType.esm.js';
 
-let isNegativeNumber=r=>isNumber(r)&&r<0;
+/**
+ * Returns whether the payload is a negative number (but not 0)
+ *
+ * @category is
+ */let isNegativeNumber=r=>isNumber(r)&&r<0;
 
 export { isNegativeNumber as default, isNegativeNumber };

package/isNull.cjs.js

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

package/isNull.esm.js

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

package/isNullOrUndefined.cjs.js

@@ -7,7 +7,11 @@ var isOneOf = require('./isOneOf.cjs.js');
 var isUndefined = require('./isUndefined.cjs.js');
 require('./getType.cjs.js');
 
-let isNullOrUndefined=isOneOf.isOneOf(isNull.isNull,isUndefined.isUndefined);
+/**
+ * Returns true whether the payload is null or undefined
+ *
+ * @category is
+ */let isNullOrUndefined=isOneOf.isOneOf(isNull.isNull,isUndefined.isUndefined);
 
 exports["default"] = isNullOrUndefined;
 exports.isNullOrUndefined = isNullOrUndefined;

package/isNullOrUndefined.esm.js

@@ -3,6 +3,10 @@ import { isOneOf } from './isOneOf.esm.js';
 import { isUndefined } from './isUndefined.esm.js';
 import './getType.esm.js';
 
-let isNullOrUndefined=isOneOf(isNull,isUndefined);
+/**
+ * Returns true whether the payload is null or undefined
+ *
+ * @category is
+ */let isNullOrUndefined=isOneOf(isNull,isUndefined);
 
 export { isNullOrUndefined as default, isNullOrUndefined };

package/isNumber.cjs.js

@@ -4,7 +4,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isNumber=r=>"Number"===getType.getType(r)&&!isNaN(r);
+/**
+ * Returns whether the payload is a number (but not NaN)
+ *
+ * This will return `false` for `NaN`!!
+ *
+ * @category is
+ */let isNumber=r=>"Number"===getType.getType(r)&&!isNaN(r);
 
 exports["default"] = isNumber;
 exports.isNumber = isNumber;

package/isNumber.esm.js

@@ -1,5 +1,11 @@
 import { getType } from './getType.esm.js';
 
-let isNumber=r=>"Number"===getType(r)&&!isNaN(r);
+/**
+ * Returns whether the payload is a number (but not NaN)
+ *
+ * This will return `false` for `NaN`!!
+ *
+ * @category is
+ */let isNumber=r=>"Number"===getType(r)&&!isNaN(r);
 
 export { isNumber as default, isNumber };

package/isNumericLiteral.cjs.js

@@ -2,7 +2,14 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let isNumericLiteral=e=>/^[+-]?\d+(\.\d+)?$/.test(e);
+/**
+ * Returns whether the payload is a numeric literal (integer or float)
+ *
+ * This will return `false` for `NaN`!!
+ *
+ * @category is
+ * @borrows [SO's answer by Paul](https://stackoverflow.com/a/10256077/1938970)
+ */let isNumericLiteral=e=>/^[+-]?\d+(\.\d+)?$/.test(e);
 
 exports["default"] = isNumericLiteral;
 exports.isNumericLiteral = isNumericLiteral;

package/isNumericLiteral.esm.js

@@ -1,3 +1,10 @@
-let isNumericLiteral=e=>/^[+-]?\d+(\.\d+)?$/.test(e);
+/**
+ * Returns whether the payload is a numeric literal (integer or float)
+ *
+ * This will return `false` for `NaN`!!
+ *
+ * @category is
+ * @borrows [SO's answer by Paul](https://stackoverflow.com/a/10256077/1938970)
+ */let isNumericLiteral=e=>/^[+-]?\d+(\.\d+)?$/.test(e);
 
 export { isNumericLiteral as default, isNumericLiteral };

package/isObject.cjs.js

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

package/isObject.esm.js

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

package/isObjectLike.cjs.js

@@ -5,7 +5,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isAnyObject = require('./isAnyObject.cjs.js');
 require('./getType.cjs.js');
 
-let isObjectLike=t=>isAnyObject.isAnyObject(t);
+/**
+ * Returns whether the payload is an object like a type passed in < >
+ *
+ * Usage: isObjectLike<{id: any}>(payload) // will make sure it's an object and has an `id` prop.
+ *
+ * @category is
+ */let isObjectLike=t=>isAnyObject.isAnyObject(t);
 
 exports["default"] = isObjectLike;
 exports.isObjectLike = isObjectLike;

package/isObjectLike.esm.js

@@ -1,6 +1,12 @@
 import { isAnyObject } from './isAnyObject.esm.js';
 import './getType.esm.js';
 
-let isObjectLike=t=>isAnyObject(t);
+/**
+ * Returns whether the payload is an object like a type passed in < >
+ *
+ * Usage: isObjectLike<{id: any}>(payload) // will make sure it's an object and has an `id` prop.
+ *
+ * @category is
+ */let isObjectLike=t=>isAnyObject(t);
 
 export { isObjectLike as default, isObjectLike };

package/isObjectStringKeyed.cjs.js

@@ -5,7 +5,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isPlainObject = require('./isPlainObject.cjs.js');
 require('./getType.cjs.js');
 
-let isObjectStringKeyed=t=>isPlainObject.isPlainObject(t);
+/**
+ * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
+ *
+ * NB: This does not actually check at runtime whether object keys are `string`s,
+ * it just narrow the type to that at TypeScript level.
+ *
+ * @category is
+ * @deprecated Probably useless function
+ */let isObjectStringKeyed=t=>isPlainObject.isPlainObject(t);
 
 exports["default"] = isObjectStringKeyed;
 exports.isObjectStringKeyed = isObjectStringKeyed;

package/isObjectStringKeyed.esm.js

@@ -1,6 +1,14 @@
 import { isPlainObject } from './isPlainObject.esm.js';
 import './getType.esm.js';
 
-let isObjectStringKeyed=t=>isPlainObject(t);
+/**
+ * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
+ *
+ * NB: This does not actually check at runtime whether object keys are `string`s,
+ * it just narrow the type to that at TypeScript level.
+ *
+ * @category is
+ * @deprecated Probably useless function
+ */let isObjectStringKeyed=t=>isPlainObject(t);
 
 export { isObjectStringKeyed as default, isObjectStringKeyed };

package/isOneOf.cjs.js

@@ -2,7 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-function isOneOf(e,n,t,f,r){return O=>e(O)||n(O)||!!t&&t(O)||!!f&&f(O)||!!r&&r(O)}
+/**
+ * @category is
+ */function isOneOf(e,n,t,f,r){return O=>e(O)||n(O)||!!t&&t(O)||!!f&&f(O)||!!r&&r(O)}
 
 exports["default"] = isOneOf;
 exports.isOneOf = isOneOf;

package/isOneOf.esm.js

@@ -1,3 +1,5 @@
-function isOneOf(e,n,t,f,r){return O=>e(O)||n(O)||!!t&&t(O)||!!f&&f(O)||!!r&&r(O)}
+/**
+ * @category is
+ */function isOneOf(e,n,t,f,r){return O=>e(O)||n(O)||!!t&&t(O)||!!f&&f(O)||!!r&&r(O)}
 
 export { isOneOf as default, isOneOf };

package/isPlainObject.cjs.js

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

package/isPlainObject.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isPlainObject=e=>"Object"===getType(e)&&e.constructor===Object&&Object.getPrototypeOf(e)===Object.prototype;
+/**
+ * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
+ *
+ * @category is
+ */let isPlainObject=e=>"Object"===getType(e)&&e.constructor===Object&&Object.getPrototypeOf(e)===Object.prototype;
 
 export { isPlainObject as default, isPlainObject };

package/isPositiveNumber.cjs.js

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

package/isPositiveNumber.esm.js

@@ -1,6 +1,10 @@
 import { isNumber } from './isNumber.esm.js';
 import './getType.esm.js';
 
-let isPositiveNumber=i=>isNumber(i)&&i>0;
+/**
+ * Returns whether the payload is a positive number (but not 0)
+ *
+ * @category is
+ */let isPositiveNumber=i=>isNumber(i)&&i>0;
 
 export { isPositiveNumber as default, isPositiveNumber };

package/isPrimitive.cjs.js

@@ -10,7 +10,11 @@ var isSymbol = require('./isSymbol.cjs.js');
 var isUndefined = require('./isUndefined.cjs.js');
 require('./getType.cjs.js');
 
-let isPrimitive=f=>isBoolean.isBoolean(f)||isNull.isNull(f)||isUndefined.isUndefined(f)||isNumber.isNumber(f)||isString.isString(f)||isSymbol.isSymbol(f);
+/**
+ * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
+ *
+ * @category is
+ */let isPrimitive=f=>isBoolean.isBoolean(f)||isNull.isNull(f)||isUndefined.isUndefined(f)||isNumber.isNumber(f)||isString.isString(f)||isSymbol.isSymbol(f);
 
 exports["default"] = isPrimitive;
 exports.isPrimitive = isPrimitive;

package/isPrimitive.esm.js

@@ -6,6 +6,10 @@ import { isSymbol } from './isSymbol.esm.js';
 import { isUndefined } from './isUndefined.esm.js';
 import './getType.esm.js';
 
-let isPrimitive=f=>isBoolean(f)||isNull(f)||isUndefined(f)||isNumber(f)||isString(f)||isSymbol(f);
+/**
+ * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
+ *
+ * @category is
+ */let isPrimitive=f=>isBoolean(f)||isNull(f)||isUndefined(f)||isNumber(f)||isString(f)||isSymbol(f);
 
 export { isPrimitive as default, isPrimitive };

package/isPromise.cjs.js

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

package/isPromise.esm.js

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

package/isRegExp.cjs.js

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

package/isRegExp.esm.js

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

package/isServer.cjs.js

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

package/isServer.esm.js

@@ -1,5 +1,8 @@
 import { isBrowser } from './isBrowser.esm.js';
 
-let isServer=!isBrowser;
+/**
+ * @category ssr
+ * @category is
+ */let isServer=!isBrowser;// export let isServer = typeof window === "undefined";
 
 export { isServer as default, isServer };

package/isServerNow.cjs.js

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