es-toolkit 1.47.0 → 1.47.1-dev.1851

package/dist/compat/object/forOwn.js

@@ -9,8 +9,8 @@ const require_keys = require("./keys.js");
 * The `iteratee` function can terminate the iteration early by returning `false`.
 *
 * @template T - The type of the object.
-* @param {T | null | undefined} object The object to iterate over.
-* @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+* @param object The object to iterate over.
+* @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
 * @return {T | null | undefined} Returns object.
 *
 * @example

package/dist/compat/object/forOwn.mjs

@@ -9,8 +9,8 @@ import { keys } from "./keys.mjs";
 * The `iteratee` function can terminate the iteration early by returning `false`.
 *
 * @template T - The type of the object.
-* @param {T | null | undefined} object The object to iterate over.
-* @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+* @param object The object to iterate over.
+* @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
 * @return {T | null | undefined} Returns object.
 *
 * @example

package/dist/compat/object/forOwnRight.d.mts

@@ -7,8 +7,8 @@
  * The `iteratee` function can terminate the iteration early by returning `false`.
  *
  * @template T - The type of the object.
- * @param {T} object The object to iterate over.
- * @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+ * @param object The object to iterate over.
+ * @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
  * @return {T} Returns object.
  *
  * @example
@@ -33,8 +33,8 @@ declare function forOwnRight<T>(object: T, iteratee?: (value: T[keyof T], key: s
  * The `iteratee` function can terminate the iteration early by returning `false`.
  *
  * @template T - The type of the object.
- * @param {T | null | undefined} object The object to iterate over.
- * @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+ * @param object The object to iterate over.
+ * @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
  * @return {T | null | undefined} Returns object.
  *
  * @example

package/dist/compat/object/forOwnRight.d.ts

@@ -7,8 +7,8 @@
  * The `iteratee` function can terminate the iteration early by returning `false`.
  *
  * @template T - The type of the object.
- * @param {T} object The object to iterate over.
- * @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+ * @param object The object to iterate over.
+ * @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
  * @return {T} Returns object.
  *
  * @example
@@ -33,8 +33,8 @@ declare function forOwnRight<T>(object: T, iteratee?: (value: T[keyof T], key: s
  * The `iteratee` function can terminate the iteration early by returning `false`.
  *
  * @template T - The type of the object.
- * @param {T | null | undefined} object The object to iterate over.
- * @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+ * @param object The object to iterate over.
+ * @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
  * @return {T | null | undefined} Returns object.
  *
  * @example

package/dist/compat/object/forOwnRight.js

@@ -9,8 +9,8 @@ const require_keys = require("./keys.js");
 * The `iteratee` function can terminate the iteration early by returning `false`.
 *
 * @template T - The type of the object.
-* @param {T | null | undefined} object The object to iterate over.
-* @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+* @param object The object to iterate over.
+* @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
 * @return {T | null | undefined} Returns object.
 *
 * @example

package/dist/compat/object/forOwnRight.mjs

@@ -9,8 +9,8 @@ import { keys } from "./keys.mjs";
 * The `iteratee` function can terminate the iteration early by returning `false`.
 *
 * @template T - The type of the object.
-* @param {T | null | undefined} object The object to iterate over.
-* @param {(value: T[keyof T], key: string, collection: T) => any} [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
+* @param object The object to iterate over.
+* @param [iteratee=identity] The function invoked per iteration. If not provided, the identity function will be used.
 * @return {T | null | undefined} Returns object.
 *
 * @example

package/dist/compat/object/fromPairs.d.mts

@@ -4,8 +4,8 @@ type PropertyName = string | number | symbol;
  * Converts an array of key-value pairs into an object.
  *
  * @template T - The type of the values.
- * @param {ArrayLike<[PropertyName, T]> | null | undefined} pairs - An array of key-value pairs.
- * @returns {Record<string, T>} - An object where keys are strings and values are of type T.
+ * @param pairs - An array of key-value pairs.
+ * @returns An object where keys are strings and values are of type T.
  *
  * @example
  * const pairs = [['a', 1], ['b', 2]];
@@ -16,8 +16,8 @@ declare function fromPairs<T>(pairs: ArrayLike<[PropertyName, T]> | null | undef
 /**
  * Converts an array of key-value pairs into an object.
  *
- * @param {ArrayLike<any[]> | null | undefined} pairs - An array of key-value pairs.
- * @returns {Record<string, any>} - An object where keys are strings and values can be any type.
+ * @param pairs - An array of key-value pairs.
+ * @returns An object where keys are strings and values can be any type.
  *
  * @example
  * const pairs = [['a', 1], ['b', 'hello']];

package/dist/compat/object/fromPairs.d.ts

@@ -4,8 +4,8 @@ type PropertyName = string | number | symbol;
  * Converts an array of key-value pairs into an object.
  *
  * @template T - The type of the values.
- * @param {ArrayLike<[PropertyName, T]> | null | undefined} pairs - An array of key-value pairs.
- * @returns {Record<string, T>} - An object where keys are strings and values are of type T.
+ * @param pairs - An array of key-value pairs.
+ * @returns An object where keys are strings and values are of type T.
  *
  * @example
  * const pairs = [['a', 1], ['b', 2]];
@@ -16,8 +16,8 @@ declare function fromPairs<T>(pairs: ArrayLike<[PropertyName, T]> | null | undef
 /**
  * Converts an array of key-value pairs into an object.
  *
- * @param {ArrayLike<any[]> | null | undefined} pairs - An array of key-value pairs.
- * @returns {Record<string, any>} - An object where keys are strings and values can be any type.
+ * @param pairs - An array of key-value pairs.
+ * @returns An object where keys are strings and values can be any type.
  *
  * @example
  * const pairs = [['a', 1], ['b', 'hello']];

package/dist/compat/object/fromPairs.js

@@ -6,8 +6,8 @@ const require_isArrayLike = require("../predicate/isArrayLike.js");
 * @template T - The type of the keys in the resulting object. It must extend `PropertyKey`.
 * @template U - The type of the values in the resulting object.
 *
-* @param {Array<[T, U]>} pairs - An array of key-value pairs where each key is a `PropertyKey` and each value is of type `U`.
-* @returns {Record<T, U>} - An object where the keys are of type `T` and the values are of type `U`.
+* @param pairs - An array of key-value pairs where each key is a `PropertyKey` and each value is of type `U`.
+* @returns An object where the keys are of type `T` and the values are of type `U`.
 *
 * @example
 * const pairs = [['a', 1], ['b', 2]];

package/dist/compat/object/fromPairs.mjs

@@ -6,8 +6,8 @@ import { isArrayLike } from "../predicate/isArrayLike.mjs";
 * @template T - The type of the keys in the resulting object. It must extend `PropertyKey`.
 * @template U - The type of the values in the resulting object.
 *
-* @param {Array<[T, U]>} pairs - An array of key-value pairs where each key is a `PropertyKey` and each value is of type `U`.
-* @returns {Record<T, U>} - An object where the keys are of type `T` and the values are of type `U`.
+* @param pairs - An array of key-value pairs where each key is a `PropertyKey` and each value is of type `U`.
+* @returns An object where the keys are of type `T` and the values are of type `U`.
 *
 * @example
 * const pairs = [['a', 1], ['b', 2]];

package/dist/compat/object/functions.d.mts

@@ -2,8 +2,8 @@
 /**
  * Creates an array of property names from an object where the property values are functions.
  *
- * @param {any} object - The object to inspect.
- * @returns {string[]} - An array of function property names.
+ * @param object - The object to inspect.
+ * @returns An array of function property names.
  *
  * @example
  * function Foo() {

package/dist/compat/object/functions.d.ts

@@ -2,8 +2,8 @@
 /**
  * Creates an array of property names from an object where the property values are functions.
  *
- * @param {any} object - The object to inspect.
- * @returns {string[]} - An array of function property names.
+ * @param object - The object to inspect.
+ * @returns An array of function property names.
  *
  * @example
  * function Foo() {

package/dist/compat/object/functions.js

@@ -6,8 +6,8 @@ const require_keys = require("./keys.js");
 * Only checks for own properties with string keys. Inherited properties or
 * properties with Symbol keys are not included.
 *
-* @param {unknown} object The object to inspect.
-* @returns {string[]} An array of function property names.
+* @param object The object to inspect.
+* @returns An array of function property names.
 *
 * @example
 *

package/dist/compat/object/functions.mjs

@@ -6,8 +6,8 @@ import { keys } from "./keys.mjs";
 * Only checks for own properties with string keys. Inherited properties or
 * properties with Symbol keys are not included.
 *
-* @param {unknown} object The object to inspect.
-* @returns {string[]} An array of function property names.
+* @param object The object to inspect.
+* @returns An array of function property names.
 *
 * @example
 *

package/dist/compat/object/functionsIn.d.mts

@@ -2,8 +2,8 @@
 /**
  * Returns an array of property names whose values are functions, including inherited properties.
  *
- * @param {*} object The object to inspect.
- * @returns {Array} Returns the function names.
+ * @param object The object to inspect.
+ * @returns Returns the function names.
  * @example
  *
  * function Foo() {

package/dist/compat/object/functionsIn.d.ts

@@ -2,8 +2,8 @@
 /**
  * Returns an array of property names whose values are functions, including inherited properties.
  *
- * @param {*} object The object to inspect.
- * @returns {Array} Returns the function names.
+ * @param object The object to inspect.
+ * @returns Returns the function names.
  * @example
  *
  * function Foo() {

package/dist/compat/object/functionsIn.js

@@ -3,8 +3,8 @@ const require_isFunction = require("../../predicate/isFunction.js");
 /**
 * Returns an array of property names whose values are functions, including inherited properties.
 *
-* @param {*} object The object to inspect.
-* @returns {Array} Returns the function names.
+* @param object The object to inspect.
+* @returns Returns the function names.
 * @example
 *
 * function Foo() {

package/dist/compat/object/functionsIn.mjs

@@ -3,8 +3,8 @@ import { isFunction } from "../../predicate/isFunction.mjs";
 /**
 * Returns an array of property names whose values are functions, including inherited properties.
 *
-* @param {*} object The object to inspect.
-* @returns {Array} Returns the function names.
+* @param object The object to inspect.
+* @returns Returns the function names.
 * @example
 *
 * function Foo() {

package/dist/compat/object/get.d.mts

@@ -7,9 +7,9 @@ import { GetFieldType } from "../_internal/GetFieldType.mjs";
  *
  * @template TObject
  * @template TKey
- * @param {TObject} object - The object to query.
- * @param {TKey | [TKey]} path - The path of the property to get.
- * @returns {TObject[TKey]} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': [{ 'b': { 'c': 3 } }] };
@@ -22,9 +22,9 @@ declare function get<TObject extends object, TKey extends keyof TObject>(object:
  *
  * @template TObject
  * @template TKey
- * @param {TObject | null | undefined} object - The object to query.
- * @param {TKey | [TKey]} path - The path of the property to get.
- * @returns {TObject[TKey] | undefined} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': [{ 'b': { 'c': 3 } }] };
@@ -38,10 +38,10 @@ declare function get<TObject extends object, TKey extends keyof TObject>(object:
  * @template TObject
  * @template TKey
  * @template TDefault
- * @param {TObject | null | undefined} object - The object to query.
- * @param {TKey | [TKey]} path - The path of the property to get.
- * @param {TDefault} defaultValue - The value returned if the resolved value is undefined.
- * @returns {Exclude<TObject[TKey], undefined> | TDefault} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @param defaultValue - The value returned if the resolved value is undefined.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': [{ 'b': { 'c': 3 } }] };
@@ -55,9 +55,9 @@ declare function get<TObject extends object, TKey extends keyof TObject, TDefaul
  * @template TObject
  * @template TKey1
  * @template TKey2
- * @param {TObject} object - The object to query.
- * @param {[TKey1, TKey2]} path - The path of the property to get.
- * @returns {TObject[TKey1][TKey2]} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': 2 } };
@@ -71,9 +71,9 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TObject
  * @template TKey1
  * @template TKey2
- * @param {TObject | null | undefined} object - The object to query.
- * @param {[TKey1, TKey2]} path - The path of the property to get.
- * @returns {NonNullable<TObject[TKey1]>[TKey2] | undefined} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': 2 } };
@@ -88,10 +88,10 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TKey1
  * @template TKey2
  * @template TDefault
- * @param {TObject | null | undefined} object - The object to query.
- * @param {[TKey1, TKey2]} path - The path of the property to get.
- * @param {TDefault} defaultValue - The value returned if the resolved value is undefined.
- * @returns {Exclude<NonNullable<TObject[TKey1]>[TKey2], undefined> | TDefault} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @param defaultValue - The value returned if the resolved value is undefined.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': 2 } };
@@ -106,9 +106,9 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TKey1
  * @template TKey2
  * @template TKey3
- * @param {TObject} object - The object to query.
- * @param {[TKey1, TKey2, TKey3]} path - The path of the property to get.
- * @returns {TObject[TKey1][TKey2][TKey3]} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': { 'c': 3 } } };
@@ -123,9 +123,9 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TKey1
  * @template TKey2
  * @template TKey3
- * @param {TObject | null | undefined} object - The object to query.
- * @param {[TKey1, TKey2, TKey3]} path - The path of the property to get.
- * @returns {NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3] | undefined} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': { 'c': 3 } } };
@@ -141,10 +141,10 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TKey2
  * @template TKey3
  * @template TDefault
- * @param {TObject | null | undefined} object - The object to query.
- * @param {[TKey1, TKey2, TKey3]} path - The path of the property to get.
- * @param {TDefault} defaultValue - The value returned if the resolved value is undefined.
- * @returns {Exclude<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3], undefined> | TDefault} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @param defaultValue - The value returned if the resolved value is undefined.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': { 'c': 3 } } };
@@ -160,9 +160,9 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TKey2
  * @template TKey3
  * @template TKey4
- * @param {TObject} object - The object to query.
- * @param {[TKey1, TKey2, TKey3, TKey4]} path - The path of the property to get.
- * @returns {TObject[TKey1][TKey2][TKey3][TKey4]} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': { 'c': { 'd': 4 } } } };
@@ -178,9 +178,9 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TKey2
  * @template TKey3
  * @template TKey4
- * @param {TObject | null | undefined} object - The object to query.
- * @param {[TKey1, TKey2, TKey3, TKey4]} path - The path of the property to get.
- * @returns {NonNullable<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]>[TKey4] | undefined} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': { 'c': { 'd': 4 } } } };
@@ -197,10 +197,10 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * @template TKey3
  * @template TKey4
  * @template TDefault
- * @param {TObject | null | undefined} object - The object to query.
- * @param {[TKey1, TKey2, TKey3, TKey4]} path - The path of the property to get.
- * @param {TDefault} defaultValue - The value returned if the resolved value is undefined.
- * @returns {Exclude<NonNullable<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]>[TKey4], undefined> | TDefault} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @param defaultValue - The value returned if the resolved value is undefined.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 'a': { 'b': { 'c': { 'd': 4 } } } };
@@ -212,9 +212,9 @@ declare function get<TObject extends object, TKey1 extends keyof TObject, TKey2
  * Gets the value at path of object.
  *
  * @template T
- * @param {Record<number, T>} object - The object to query.
- * @param {number} path - The path of the property to get.
- * @returns {T} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 0: 'a', 1: 'b', 2: 'c' };
@@ -226,9 +226,9 @@ declare function get<T>(object: Record<number, T>, path: number): T;
  * Gets the value at path of object. If the resolved value is undefined, undefined is returned.
  *
  * @template T
- * @param {Record<number, T> | null | undefined} object - The object to query.
- * @param {number} path - The path of the property to get.
- * @returns {T | undefined} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 0: 'a', 1: 'b', 2: 'c' };
@@ -241,10 +241,10 @@ declare function get<T>(object: Record<number, T> | null | undefined, path: numb
  *
  * @template T
  * @template TDefault
- * @param {Record<number, T> | null | undefined} object - The object to query.
- * @param {number} path - The path of the property to get.
- * @param {TDefault} defaultValue - The value returned if the resolved value is undefined.
- * @returns {T | TDefault} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @param defaultValue - The value returned if the resolved value is undefined.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { 0: 'a', 1: 'b', 2: 'c' };
@@ -256,10 +256,10 @@ declare function get<T, TDefault>(object: Record<number, T> | null | undefined,
  * Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
  *
  * @template TDefault
- * @param {null | undefined} object - The object to query.
- * @param {PropertyPath} path - The path of the property to get.
- * @param {TDefault} defaultValue - The value returned if the resolved value is undefined.
- * @returns {TDefault} Returns the default value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @param defaultValue - The value returned if the resolved value is undefined.
+ * @returns Returns the default value.
  *
  * @example
  * get(null, 'a.b.c', 'default');
@@ -269,9 +269,9 @@ declare function get<TDefault>(object: null | undefined, path: PropertyPath, def
 /**
  * Gets the value at path of object. If the resolved value is undefined, undefined is returned.
  *
- * @param {null | undefined} object - The object to query.
- * @param {PropertyPath} path - The path of the property to get.
- * @returns {undefined} Returns undefined.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns undefined.
  *
  * @example
  * get(null, 'a.b.c');
@@ -283,9 +283,9 @@ declare function get(object: null | undefined, path: PropertyPath): undefined;
  *
  * @template TObject
  * @template TPath
- * @param {TObject} data - The object to query.
- * @param {TPath} path - The path of the property to get.
- * @returns {string extends TPath ? any : GetFieldType<TObject, TPath>} Returns the resolved value.
+ * @param data - The object to query.
+ * @param path - The path of the property to get.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { a: { b: { c: 1 } } };
@@ -299,10 +299,10 @@ declare function get<TObject, TPath extends string>(data: TObject, path: TPath):
  * @template TObject
  * @template TPath
  * @template TDefault
- * @param {TObject} data - The object to query.
- * @param {TPath} path - The path of the property to get.
- * @param {TDefault} defaultValue - The value returned if the resolved value is undefined.
- * @returns {Exclude<GetFieldType<TObject, TPath>, null | undefined> | TDefault} Returns the resolved value.
+ * @param data - The object to query.
+ * @param path - The path of the property to get.
+ * @param defaultValue - The value returned if the resolved value is undefined.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { a: { b: { c: 1 } } };
@@ -313,10 +313,10 @@ declare function get<TObject, TPath extends string, TDefault = GetFieldType<TObj
 /**
  * Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned.
  *
- * @param {any} object - The object to query.
- * @param {PropertyPath} path - The path of the property to get.
- * @param {any} [defaultValue] - The value returned if the resolved value is undefined.
- * @returns {any} Returns the resolved value.
+ * @param object - The object to query.
+ * @param path - The path of the property to get.
+ * @param [defaultValue] - The value returned if the resolved value is undefined.
+ * @returns Returns the resolved value.
  *
  * @example
  * const object = { a: { b: { c: 1 } } };