yummies 3.2.0 → 3.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yummies",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "keywords": [],
   "author": "js2me",
   "license": "MIT",
@@ -192,7 +192,8 @@
       "default": "./vibrate.js",
       "types": "./vibrate.d.ts"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./utility-types": "./utility-types.d.ts"
   },
   "files": [
     "*"

package/type-guard/_exports.d.ts

@@ -1,16 +1,86 @@
 import { AnyFunction, AnyObject } from '../utils/types.js';
+/**
+ * Check if a value is not null or undefined
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isDefined: <T>(value: T | undefined | null) => value is T;
+/**
+ * Check if a value is null
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isNull: (value: unknown) => value is null;
+/**
+ * Check if a value is undefined
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isUndefined: (value: unknown) => value is undefined;
+/**
+ * Check if a value is an object
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isObject: (value: unknown) => value is AnyObject;
+/**
+ * Check if a value is an array
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isArray: (value: unknown) => value is unknown[];
+/**
+ * Check if a value is a string
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isString: (value: unknown) => value is string;
+/**
+ * Check if a value is a number
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isNumber: (value: unknown) => value is number;
+/**
+ * Check if a value is a boolean
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isBoolean: (value: unknown) => value is boolean;
+/**
+ * Check if a value is a function
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isFunction: (value: unknown) => value is AnyFunction;
+/**
+ * Check if a value is a regular expression
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isRegExp: (value: unknown) => value is boolean;
+/**
+ * Check if a value is a DOM element
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isElement: (value: unknown) => value is HTMLElement;
+/**
+ * Check if a value is NaN
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isNaN: (value: unknown) => value is number;
+/**
+ * Check if a value is infinity
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isInfinite: (value: unknown) => value is number;
+/**
+ * Check if a value is a symbol
+ * @param value the value to check
+ * @returns boolean
+ */
 export declare const isSymbol: (value: unknown) => value is symbol;
 //# sourceMappingURL=_exports.d.ts.map

package/type-guard/_exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"_exports.d.ts","sourceRoot":"","sources":["../../src/type-guard/_exports.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAqD3D,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,IAAI,KAAG,KAAK,IAAI,CACrD,CAAC;AAEhB,eAAO,MAAM,MAAM,UANT,OAAO,KAAG,KAAK,QAM6B,CAAC;AACvD,eAAO,MAAM,WAAW,UAPd,OAAO,KAAG,KAAK,aAO4C,CAAC;AACtE,eAAO,MAAM,QAAQ,UARX,OAAO,KAAG,KAAK,aAQsC,CAAC;AAChE,eAAO,MAAM,OAAO,UATV,OAAO,KAAG,KAAK,aASoC,CAAC;AAC9D,eAAO,MAAM,QAAQ,UAVX,OAAO,KAAG,KAAK,UAUmC,CAAC;AAC7D,eAAO,MAAM,QAAQ,UAXX,OAAO,KAAG,KAAK,UAWmC,CAAC;AAC7D,eAAO,MAAM,SAAS,UAZZ,OAAO,KAAG,KAAK,WAYsC,CAAC;AAChE,eAAO,MAAM,UAAU,UAbb,OAAO,KAAG,KAAK,eAa4C,CAAC;AACtE,eAAO,MAAM,QAAQ,UAdX,OAAO,KAAG,KAAK,WAcoC,CAAC;AAC9D,eAAO,MAAM,SAAS,UAfZ,OAAO,KAAG,KAAK,eAe0C,CAAC;AACpE,eAAO,MAAM,KAAK,UAhBR,OAAO,KAAG,KAAK,UAgB6B,CAAC;AACvD,eAAO,MAAM,UAAU,UAjBb,OAAO,KAAG,KAAK,UAiBuC,CAAC;AACjE,eAAO,MAAM,QAAQ,UAlBX,OAAO,KAAG,KAAK,UAkBmC,CAAC"}
+{"version":3,"file":"_exports.d.ts","sourceRoot":"","sources":["../../src/type-guard/_exports.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAqD3D;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,IAAI,KAAG,KAAK,IAAI,CACrD,CAAC;AAEhB;;;;GAIG;AACH,eAAO,MAAM,MAAM,UAhBT,OAAO,KAAG,KAAK,QAgB6B,CAAC;AAEvD;;;;GAIG;AACH,eAAO,MAAM,WAAW,UAvBd,OAAO,KAAG,KAAK,aAuB4C,CAAC;AAEtE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UA9BX,OAAO,KAAG,KAAK,aA8BsC,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,OAAO,UArCV,OAAO,KAAG,KAAK,aAqCoC,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UA5CX,OAAO,KAAG,KAAK,UA4CmC,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UAnDX,OAAO,KAAG,KAAK,UAmDmC,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,SAAS,UA1DZ,OAAO,KAAG,KAAK,WA0DsC,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,UAAU,UAjEb,OAAO,KAAG,KAAK,eAiE4C,CAAC;AAEtE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UAxEX,OAAO,KAAG,KAAK,WAwEoC,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,SAAS,UA/EZ,OAAO,KAAG,KAAK,eA+E0C,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,KAAK,UAtFR,OAAO,KAAG,KAAK,UAsF6B,CAAC;AAEvD;;;;GAIG;AACH,eAAO,MAAM,UAAU,UA7Fb,OAAO,KAAG,KAAK,UA6FuC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UApGX,OAAO,KAAG,KAAK,UAoGmC,CAAC"}

package/type-guard/_exports.js

@@ -40,17 +40,87 @@ function getType(value) {
     return stringifiedValue;
 }
 const createTypeGuard = (type) => (value) => getType(value) === type;
+/**
+ * Check if a value is not null or undefined
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isDefined = (value) => value != null;
+/**
+ * Check if a value is null
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isNull = createTypeGuard(Type.Null);
+/**
+ * Check if a value is undefined
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isUndefined = createTypeGuard(Type.Undefined);
+/**
+ * Check if a value is an object
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isObject = createTypeGuard(Type.Object);
+/**
+ * Check if a value is an array
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isArray = createTypeGuard(Type.Array);
+/**
+ * Check if a value is a string
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isString = createTypeGuard(Type.String);
+/**
+ * Check if a value is a number
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isNumber = createTypeGuard(Type.Number);
+/**
+ * Check if a value is a boolean
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isBoolean = createTypeGuard(Type.Boolean);
+/**
+ * Check if a value is a function
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isFunction = createTypeGuard(Type.Function);
+/**
+ * Check if a value is a regular expression
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isRegExp = createTypeGuard(Type.RegExp);
+/**
+ * Check if a value is a DOM element
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isElement = createTypeGuard(Type.Element);
+/**
+ * Check if a value is NaN
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isNaN = createTypeGuard(Type.NaN);
+/**
+ * Check if a value is infinity
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isInfinite = createTypeGuard(Type.Infinite);
+/**
+ * Check if a value is a symbol
+ * @param value the value to check
+ * @returns boolean
+ */
 export const isSymbol = createTypeGuard(Type.Symbol);