es-toolkit 1.47.0-dev.1841 → 1.47.0-dev.1843

package/dist/predicate/isJSONValue.mjs

@@ -15,8 +15,8 @@ import { isPlainObject } from "./isPlainObject.mjs";
 * - a number
 * - a boolean
 *
-* @param {unknown} value - The value to check.
-* @returns {boolean} - True if the value is a valid JSON value, otherwise false.
+* @param value - The value to check.
+* @returns True if the value is a valid JSON value, otherwise false.
 *
 * @example
 * console.log(isJSONValue(null)); // true
@@ -42,8 +42,8 @@ function isJSONValue(value) {
 *
 * A valid JSON array is defined as an array where all items are valid JSON values.
 *
-* @param {unknown} value - The value to check.
-* @returns {value is any[]} - True if the value is a valid JSON array, otherwise false.
+* @param value - The value to check.
+* @returns True if the value is a valid JSON array, otherwise false.
 *
 * @example
 * console.log(isJSONArray([1, 2, 3])); // true
@@ -60,8 +60,8 @@ function isJSONArray(value) {
 *
 * A valid JSON object is defined as an object with string keys and valid JSON values.
 *
-* @param {unknown} obj The value to check.
-* @returns {obj is Record<string, any>} True if `obj` is a JSON object, false otherwise.
+* @param obj The value to check.
+* @returns True if `obj` is a JSON object, false otherwise.
 *
 * @example
 * isJSONObject({ nested: { boolean: true, array: [1, 2, 3], string: 'test', null: null } }); // true

package/dist/predicate/isLength.d.mts

@@ -9,8 +9,8 @@
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the
  * argument to a valid length (`number`).
  *
- * @param {any} value The value to check.
- * @returns {boolean} Returns `true` if `value` is a valid length, else `false`.
+ * @param value The value to check.
+ * @returns Returns `true` if `value` is a valid length, else `false`.
  *
  * @example
  * isLength(0); // true

package/dist/predicate/isLength.d.ts

@@ -9,8 +9,8 @@
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the
  * argument to a valid length (`number`).
  *
- * @param {any} value The value to check.
- * @returns {boolean} Returns `true` if `value` is a valid length, else `false`.
+ * @param value The value to check.
+ * @returns Returns `true` if `value` is a valid length, else `false`.
  *
  * @example
  * isLength(0); // true

package/dist/predicate/isLength.js

@@ -9,8 +9,8 @@
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the
 * argument to a valid length (`number`).
 *
-* @param {any} value The value to check.
-* @returns {boolean} Returns `true` if `value` is a valid length, else `false`.
+* @param value The value to check.
+* @returns Returns `true` if `value` is a valid length, else `false`.
 *
 * @example
 * isLength(0); // true

package/dist/predicate/isLength.mjs

@@ -9,8 +9,8 @@
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the
 * argument to a valid length (`number`).
 *
-* @param {any} value The value to check.
-* @returns {boolean} Returns `true` if `value` is a valid length, else `false`.
+* @param value The value to check.
+* @returns Returns `true` if `value` is a valid length, else `false`.
 *
 * @example
 * isLength(0); // true

package/dist/predicate/isMap.d.mts

@@ -4,8 +4,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Map`.
  *
- * @param {unknown} value The value to check if it is a `Map`.
- * @returns {value is Map<any, any>} Returns `true` if `value` is a `Map`, else `false`.
+ * @param value The value to check if it is a `Map`.
+ * @returns Returns `true` if `value` is a `Map`, else `false`.
  *
  * @example
  * const value1 = new Map();

package/dist/predicate/isMap.d.ts

@@ -4,8 +4,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Map`.
  *
- * @param {unknown} value The value to check if it is a `Map`.
- * @returns {value is Map<any, any>} Returns `true` if `value` is a `Map`, else `false`.
+ * @param value The value to check if it is a `Map`.
+ * @returns Returns `true` if `value` is a `Map`, else `false`.
  *
  * @example
  * const value1 = new Map();

package/dist/predicate/isMap.js

@@ -4,8 +4,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Map`.
 *
-* @param {unknown} value The value to check if it is a `Map`.
-* @returns {value is Map<any, any>} Returns `true` if `value` is a `Map`, else `false`.
+* @param value The value to check if it is a `Map`.
+* @returns Returns `true` if `value` is a `Map`, else `false`.
 *
 * @example
 * const value1 = new Map();

package/dist/predicate/isMap.mjs

@@ -4,8 +4,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Map`.
 *
-* @param {unknown} value The value to check if it is a `Map`.
-* @returns {value is Map<any, any>} Returns `true` if `value` is a `Map`, else `false`.
+* @param value The value to check if it is a `Map`.
+* @returns Returns `true` if `value` is a `Map`, else `false`.
 *
 * @example
 * const value1 = new Map();

package/dist/predicate/isNil.d.mts

@@ -7,8 +7,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null` or `undefined`.
  *
- * @param {unknown} x - The value to test for null or undefined.
- * @returns {boolean} `true` if the value is null or undefined, `false` otherwise.
+ * @param x - The value to test for null or undefined.
+ * @returns `true` if the value is null or undefined, `false` otherwise.
  *
  * @example
  * const value1 = null;

package/dist/predicate/isNil.d.ts

@@ -7,8 +7,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null` or `undefined`.
  *
- * @param {unknown} x - The value to test for null or undefined.
- * @returns {boolean} `true` if the value is null or undefined, `false` otherwise.
+ * @param x - The value to test for null or undefined.
+ * @returns `true` if the value is null or undefined, `false` otherwise.
  *
  * @example
  * const value1 = null;

package/dist/predicate/isNil.js

@@ -7,8 +7,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null` or `undefined`.
 *
-* @param {unknown} x - The value to test for null or undefined.
-* @returns {boolean} `true` if the value is null or undefined, `false` otherwise.
+* @param x - The value to test for null or undefined.
+* @returns `true` if the value is null or undefined, `false` otherwise.
 *
 * @example
 * const value1 = null;

package/dist/predicate/isNil.mjs

@@ -7,8 +7,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null` or `undefined`.
 *
-* @param {unknown} x - The value to test for null or undefined.
-* @returns {boolean} `true` if the value is null or undefined, `false` otherwise.
+* @param x - The value to test for null or undefined.
+* @returns `true` if the value is null or undefined, `false` otherwise.
 *
 * @example
 * const value1 = null;

package/dist/predicate/isNode.d.mts

@@ -5,7 +5,7 @@
  * This function checks for the existence of the `process.versions.node` property,
  * which only exists in Node.js environments.
  *
- * @returns {boolean} `true` if the current environment is Node.js, otherwise `false`.
+ * @returns `true` if the current environment is Node.js, otherwise `false`.
  *
  * @example
  * if (isNode()) {

package/dist/predicate/isNode.d.ts

@@ -5,7 +5,7 @@
  * This function checks for the existence of the `process.versions.node` property,
  * which only exists in Node.js environments.
  *
- * @returns {boolean} `true` if the current environment is Node.js, otherwise `false`.
+ * @returns `true` if the current environment is Node.js, otherwise `false`.
  *
  * @example
  * if (isNode()) {

package/dist/predicate/isNode.js

@@ -5,7 +5,7 @@
 * This function checks for the existence of the `process.versions.node` property,
 * which only exists in Node.js environments.
 *
-* @returns {boolean} `true` if the current environment is Node.js, otherwise `false`.
+* @returns `true` if the current environment is Node.js, otherwise `false`.
 *
 * @example
 * if (isNode()) {

package/dist/predicate/isNode.mjs

@@ -5,7 +5,7 @@
 * This function checks for the existence of the `process.versions.node` property,
 * which only exists in Node.js environments.
 *
-* @returns {boolean} `true` if the current environment is Node.js, otherwise `false`.
+* @returns `true` if the current environment is Node.js, otherwise `false`.
 *
 * @example
 * if (isNode()) {

package/dist/predicate/isNotNil.d.mts

@@ -5,8 +5,8 @@
  * The main use of this function is to be used with TypeScript as a type predicate.
  *
  * @template T - The type of value.
- * @param {T | null | undefined} x - The value to test if it is not null nor undefined.
- * @returns {x is T} True if the value is not null nor undefined, false otherwise.
+ * @param x - The value to test if it is not null nor undefined.
+ * @returns True if the value is not null nor undefined, false otherwise.
  *
  * @example
  * // Here the type of `arr` is (number | undefined)[]

package/dist/predicate/isNotNil.d.ts

@@ -5,8 +5,8 @@
  * The main use of this function is to be used with TypeScript as a type predicate.
  *
  * @template T - The type of value.
- * @param {T | null | undefined} x - The value to test if it is not null nor undefined.
- * @returns {x is T} True if the value is not null nor undefined, false otherwise.
+ * @param x - The value to test if it is not null nor undefined.
+ * @returns True if the value is not null nor undefined, false otherwise.
  *
  * @example
  * // Here the type of `arr` is (number | undefined)[]

package/dist/predicate/isNotNil.js

@@ -5,8 +5,8 @@
 * The main use of this function is to be used with TypeScript as a type predicate.
 *
 * @template T - The type of value.
-* @param {T | null | undefined} x - The value to test if it is not null nor undefined.
-* @returns {x is T} True if the value is not null nor undefined, false otherwise.
+* @param x - The value to test if it is not null nor undefined.
+* @returns True if the value is not null nor undefined, false otherwise.
 *
 * @example
 * // Here the type of `arr` is (number | undefined)[]

package/dist/predicate/isNotNil.mjs

@@ -5,8 +5,8 @@
 * The main use of this function is to be used with TypeScript as a type predicate.
 *
 * @template T - The type of value.
-* @param {T | null | undefined} x - The value to test if it is not null nor undefined.
-* @returns {x is T} True if the value is not null nor undefined, false otherwise.
+* @param x - The value to test if it is not null nor undefined.
+* @returns True if the value is not null nor undefined, false otherwise.
 *
 * @example
 * // Here the type of `arr` is (number | undefined)[]

package/dist/predicate/isNull.d.mts

@@ -7,8 +7,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null`.
  *
- * @param {unknown} x - The value to test if it is null.
- * @returns {x is null} True if the value is null, false otherwise.
+ * @param x - The value to test if it is null.
+ * @returns True if the value is null, false otherwise.
  *
  * @example
  * const value1 = null;

package/dist/predicate/isNull.d.ts

@@ -7,8 +7,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null`.
  *
- * @param {unknown} x - The value to test if it is null.
- * @returns {x is null} True if the value is null, false otherwise.
+ * @param x - The value to test if it is null.
+ * @returns True if the value is null, false otherwise.
  *
  * @example
  * const value1 = null;

package/dist/predicate/isNull.js

@@ -7,8 +7,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null`.
 *
-* @param {unknown} x - The value to test if it is null.
-* @returns {x is null} True if the value is null, false otherwise.
+* @param x - The value to test if it is null.
+* @returns True if the value is null, false otherwise.
 *
 * @example
 * const value1 = null;

package/dist/predicate/isNull.mjs

@@ -7,8 +7,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null`.
 *
-* @param {unknown} x - The value to test if it is null.
-* @returns {x is null} True if the value is null, false otherwise.
+* @param x - The value to test if it is null.
+* @returns True if the value is null, false otherwise.
 *
 * @example
 * const value1 = null;

package/dist/predicate/isNumber.d.mts

@@ -7,8 +7,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `number`.
  *
- * @param {unknown} x - The value to test if it is a number.
- * @returns {x is number} True if the value is a number, false otherwise.
+ * @param x - The value to test if it is a number.
+ * @returns True if the value is a number, false otherwise.
  *
  * @example
  *

package/dist/predicate/isNumber.d.ts

@@ -7,8 +7,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `number`.
  *
- * @param {unknown} x - The value to test if it is a number.
- * @returns {x is number} True if the value is a number, false otherwise.
+ * @param x - The value to test if it is a number.
+ * @returns True if the value is a number, false otherwise.
  *
  * @example
  *

package/dist/predicate/isNumber.js

@@ -7,8 +7,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `number`.
 *
-* @param {unknown} x - The value to test if it is a number.
-* @returns {x is number} True if the value is a number, false otherwise.
+* @param x - The value to test if it is a number.
+* @returns True if the value is a number, false otherwise.
 *
 * @example
 *

package/dist/predicate/isNumber.mjs

@@ -7,8 +7,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `number`.
 *
-* @param {unknown} x - The value to test if it is a number.
-* @returns {x is number} True if the value is a number, false otherwise.
+* @param x - The value to test if it is a number.
+* @returns True if the value is a number, false otherwise.
 *
 * @example
 *

package/dist/predicate/isPlainObject.d.mts

@@ -2,8 +2,8 @@
 /**
  * Checks if a given value is a plain object.
  *
- * @param {object} value - The value to check.
- * @returns {value is Record<PropertyKey, any>} - True if the value is a plain object, otherwise false.
+ * @param value - The value to check.
+ * @returns True if the value is a plain object, otherwise false.
  *
  * @example
  * ```typescript

package/dist/predicate/isPlainObject.d.ts

@@ -2,8 +2,8 @@
 /**
  * Checks if a given value is a plain object.
  *
- * @param {object} value - The value to check.
- * @returns {value is Record<PropertyKey, any>} - True if the value is a plain object, otherwise false.
+ * @param value - The value to check.
+ * @returns True if the value is a plain object, otherwise false.
  *
  * @example
  * ```typescript

package/dist/predicate/isPlainObject.js

@@ -2,8 +2,8 @@
 /**
 * Checks if a given value is a plain object.
 *
-* @param {object} value - The value to check.
-* @returns {value is Record<PropertyKey, any>} - True if the value is a plain object, otherwise false.
+* @param value - The value to check.
+* @returns True if the value is a plain object, otherwise false.
 *
 * @example
 * ```typescript

package/dist/predicate/isPlainObject.mjs

@@ -2,8 +2,8 @@
 /**
 * Checks if a given value is a plain object.
 *
-* @param {object} value - The value to check.
-* @returns {value is Record<PropertyKey, any>} - True if the value is a plain object, otherwise false.
+* @param value - The value to check.
+* @returns True if the value is a plain object, otherwise false.
 *
 * @example
 * ```typescript

package/dist/predicate/isPrimitive.d.mts

@@ -3,15 +3,8 @@
  * Checks whether a value is a JavaScript primitive.
  * JavaScript primitives include null, undefined, strings, numbers, booleans, symbols, and bigints.
  *
- * @param {unknown} value The value to check.
- * @returns {value is
- *     null
- *   | undefined
- *   | string
- *   | number
- *   | boolean
- *   | symbol
- *   | bigint} Returns true if `value` is a primitive, false otherwise.
+ * @param value The value to check.
+ * @returns Returns true if `value` is a primitive, false otherwise.
  *
  * @example
  * isPrimitive(null); // true

package/dist/predicate/isPrimitive.d.ts

@@ -3,15 +3,8 @@
  * Checks whether a value is a JavaScript primitive.
  * JavaScript primitives include null, undefined, strings, numbers, booleans, symbols, and bigints.
  *
- * @param {unknown} value The value to check.
- * @returns {value is
- *     null
- *   | undefined
- *   | string
- *   | number
- *   | boolean
- *   | symbol
- *   | bigint} Returns true if `value` is a primitive, false otherwise.
+ * @param value The value to check.
+ * @returns Returns true if `value` is a primitive, false otherwise.
  *
  * @example
  * isPrimitive(null); // true

package/dist/predicate/isPrimitive.js

@@ -3,15 +3,8 @@
 * Checks whether a value is a JavaScript primitive.
 * JavaScript primitives include null, undefined, strings, numbers, booleans, symbols, and bigints.
 *
-* @param {unknown} value The value to check.
-* @returns {value is
-*     null
-*   | undefined
-*   | string
-*   | number
-*   | boolean
-*   | symbol
-*   | bigint} Returns true if `value` is a primitive, false otherwise.
+* @param value The value to check.
+* @returns Returns true if `value` is a primitive, false otherwise.
 *
 * @example
 * isPrimitive(null); // true

package/dist/predicate/isPrimitive.mjs

@@ -3,15 +3,8 @@
 * Checks whether a value is a JavaScript primitive.
 * JavaScript primitives include null, undefined, strings, numbers, booleans, symbols, and bigints.
 *
-* @param {unknown} value The value to check.
-* @returns {value is
-*     null
-*   | undefined
-*   | string
-*   | number
-*   | boolean
-*   | symbol
-*   | bigint} Returns true if `value` is a primitive, false otherwise.
+* @param value The value to check.
+* @returns Returns true if `value` is a primitive, false otherwise.
 *
 * @example
 * isPrimitive(null); // true

package/dist/predicate/isPromise.d.mts

@@ -4,8 +4,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Promise`.
  *
- * @param {unknown} value The value to check if it is a `Promise`.
- * @returns {value is Promise<any>} Returns `true` if `value` is a `Promise`, else `false`.
+ * @param value The value to check if it is a `Promise`.
+ * @returns Returns `true` if `value` is a `Promise`, else `false`.
  *
  * @example
  * const value1 = new Promise((resolve) => resolve());

package/dist/predicate/isPromise.d.ts

@@ -4,8 +4,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Promise`.
  *
- * @param {unknown} value The value to check if it is a `Promise`.
- * @returns {value is Promise<any>} Returns `true` if `value` is a `Promise`, else `false`.
+ * @param value The value to check if it is a `Promise`.
+ * @returns Returns `true` if `value` is a `Promise`, else `false`.
  *
  * @example
  * const value1 = new Promise((resolve) => resolve());

package/dist/predicate/isPromise.js

@@ -4,8 +4,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Promise`.
 *
-* @param {unknown} value The value to check if it is a `Promise`.
-* @returns {value is Promise<any>} Returns `true` if `value` is a `Promise`, else `false`.
+* @param value The value to check if it is a `Promise`.
+* @returns Returns `true` if `value` is a `Promise`, else `false`.
 *
 * @example
 * const value1 = new Promise((resolve) => resolve());

package/dist/predicate/isPromise.mjs

@@ -4,8 +4,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Promise`.
 *
-* @param {unknown} value The value to check if it is a `Promise`.
-* @returns {value is Promise<any>} Returns `true` if `value` is a `Promise`, else `false`.
+* @param value The value to check if it is a `Promise`.
+* @returns Returns `true` if `value` is a `Promise`, else `false`.
 *
 * @example
 * const value1 = new Promise((resolve) => resolve());

package/dist/predicate/isRegExp.d.mts

@@ -2,8 +2,8 @@
 /**
  * Checks if `value` is a RegExp.
  *
- * @param {unknown} value The value to check.
- * @returns {value is RegExp} Returns `true` if `value` is a RegExp, `false` otherwise.
+ * @param value The value to check.
+ * @returns Returns `true` if `value` is a RegExp, `false` otherwise.
  *
  * @example
  * const value1 = /abc/;

package/dist/predicate/isRegExp.d.ts

@@ -2,8 +2,8 @@
 /**
  * Checks if `value` is a RegExp.
  *
- * @param {unknown} value The value to check.
- * @returns {value is RegExp} Returns `true` if `value` is a RegExp, `false` otherwise.
+ * @param value The value to check.
+ * @returns Returns `true` if `value` is a RegExp, `false` otherwise.
  *
  * @example
  * const value1 = /abc/;

package/dist/predicate/isRegExp.js

@@ -2,8 +2,8 @@
 /**
 * Checks if `value` is a RegExp.
 *
-* @param {unknown} value The value to check.
-* @returns {value is RegExp} Returns `true` if `value` is a RegExp, `false` otherwise.
+* @param value The value to check.
+* @returns Returns `true` if `value` is a RegExp, `false` otherwise.
 *
 * @example
 * const value1 = /abc/;

package/dist/predicate/isRegExp.mjs

@@ -2,8 +2,8 @@
 /**
 * Checks if `value` is a RegExp.
 *
-* @param {unknown} value The value to check.
-* @returns {value is RegExp} Returns `true` if `value` is a RegExp, `false` otherwise.
+* @param value The value to check.
+* @returns Returns `true` if `value` is a RegExp, `false` otherwise.
 *
 * @example
 * const value1 = /abc/;

package/dist/predicate/isSet.d.mts

@@ -4,8 +4,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Set`.
  *
- * @param {unknown} value The value to check if it is a `Set`.
- * @returns {value is Set<any>} Returns `true` if `value` is a `Set`, else `false`.
+ * @param value The value to check if it is a `Set`.
+ * @returns Returns `true` if `value` is a `Set`, else `false`.
  *
  * @example
  * const value1 = new Set();

package/dist/predicate/isSet.d.ts

@@ -4,8 +4,8 @@
  *
  * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Set`.
  *
- * @param {unknown} value The value to check if it is a `Set`.
- * @returns {value is Set<any>} Returns `true` if `value` is a `Set`, else `false`.
+ * @param value The value to check if it is a `Set`.
+ * @returns Returns `true` if `value` is a `Set`, else `false`.
  *
  * @example
  * const value1 = new Set();

package/dist/predicate/isSet.js

@@ -4,8 +4,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Set`.
 *
-* @param {unknown} value The value to check if it is a `Set`.
-* @returns {value is Set<any>} Returns `true` if `value` is a `Set`, else `false`.
+* @param value The value to check if it is a `Set`.
+* @returns Returns `true` if `value` is a `Set`, else `false`.
 *
 * @example
 * const value1 = new Set();

package/dist/predicate/isSet.mjs

@@ -4,8 +4,8 @@
 *
 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Set`.
 *
-* @param {unknown} value The value to check if it is a `Set`.
-* @returns {value is Set<any>} Returns `true` if `value` is a `Set`, else `false`.
+* @param value The value to check if it is a `Set`.
+* @returns Returns `true` if `value` is a `Set`, else `false`.
 *
 * @example
 * const value1 = new Set();