es-toolkit 1.47.0 → 1.47.1-dev.1851

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

@@ -5,9 +5,9 @@ import { ValueKeyIteratee } from "../_internal/ValueKeyIteratee.mjs";
  * Creates a new object composed of the properties that do not satisfy the predicate function.
  *
  * @template T
- * @param {Record<string, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} predicate - The function invoked per property.
- * @returns {Record<string, T>} Returns the new object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
  *
  * @example
  * omitBy({ 'a': 1, 'b': '2', 'c': 3 }, isString);
@@ -18,9 +18,9 @@ declare function omitBy<T>(object: Record<string, T> | null | undefined, predica
  * Creates a new object composed of the properties that do not satisfy the predicate function.
  *
  * @template T
- * @param {Record<number, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} predicate - The function invoked per property.
- * @returns {Record<number, T>} Returns the new object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
  *
  * @example
  * omitBy({ 0: 1, 1: '2', 2: 3 }, isString);
@@ -31,9 +31,9 @@ declare function omitBy<T>(object: Record<number, T> | null | undefined, predica
  * Creates a new object composed of the properties that do not satisfy the predicate function.
  *
  * @template T
- * @param {T | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T[keyof T]>} predicate - The function invoked per property.
- * @returns {Partial<T>} Returns the new object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
  *
  * @example
  * omitBy({ 'a': 1, 'b': '2', 'c': 3 }, isString);

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

@@ -5,9 +5,9 @@ import { ValueKeyIteratee } from "../_internal/ValueKeyIteratee.js";
  * Creates a new object composed of the properties that do not satisfy the predicate function.
  *
  * @template T
- * @param {Record<string, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} predicate - The function invoked per property.
- * @returns {Record<string, T>} Returns the new object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
  *
  * @example
  * omitBy({ 'a': 1, 'b': '2', 'c': 3 }, isString);
@@ -18,9 +18,9 @@ declare function omitBy<T>(object: Record<string, T> | null | undefined, predica
  * Creates a new object composed of the properties that do not satisfy the predicate function.
  *
  * @template T
- * @param {Record<number, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} predicate - The function invoked per property.
- * @returns {Record<number, T>} Returns the new object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
  *
  * @example
  * omitBy({ 0: 1, 1: '2', 2: 3 }, isString);
@@ -31,9 +31,9 @@ declare function omitBy<T>(object: Record<number, T> | null | undefined, predica
  * Creates a new object composed of the properties that do not satisfy the predicate function.
  *
  * @template T
- * @param {T | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T[keyof T]>} predicate - The function invoked per property.
- * @returns {Partial<T>} Returns the new object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
  *
  * @example
  * omitBy({ 'a': 1, 'b': '2', 'c': 3 }, isString);

package/dist/compat/object/omitBy.js

@@ -11,11 +11,11 @@ const require_getSymbolsIn = require("../_internal/getSymbolsIn.js");
 * includes only the properties for which the predicate function returns false.
 *
 * @template T - The type of object.
-* @param {T} obj - The object to omit properties from.
-* @param {(value: T[keyof T], key: keyof T, obj: T) => boolean} shouldOmit - A predicate function that determines
+* @param obj - The object to omit properties from.
+* @param shouldOmit - A predicate function that determines
 * whether a property should be omitted. It takes the property's value, key, and the source object as arguments and returns `true`
 * if the property should be omitted, and `false` otherwise.
-* @returns {Partial<T>} Returns the new object.
+* @returns Returns the new object.
 *
 * @example
 * const obj = { a: 1, b: 'omit', c: 3 };

package/dist/compat/object/omitBy.mjs

@@ -11,11 +11,11 @@ import { getSymbolsIn } from "../_internal/getSymbolsIn.mjs";
 * includes only the properties for which the predicate function returns false.
 *
 * @template T - The type of object.
-* @param {T} obj - The object to omit properties from.
-* @param {(value: T[keyof T], key: keyof T, obj: T) => boolean} shouldOmit - A predicate function that determines
+* @param obj - The object to omit properties from.
+* @param shouldOmit - A predicate function that determines
 * whether a property should be omitted. It takes the property's value, key, and the source object as arguments and returns `true`
 * if the property should be omitted, and `false` otherwise.
-* @returns {Partial<T>} Returns the new object.
+* @returns Returns the new object.
 *
 * @example
 * const obj = { a: 1, b: 'omit', c: 3 };

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

@@ -7,9 +7,9 @@ import { PropertyPath } from "../_internal/PropertyPath.mjs";
  *
  * @template T - The type of object.
  * @template U - The type of keys to pick.
- * @param {T} object - The object to pick keys from.
- * @param {...Array<Many<U>>} props - An array of keys to be picked from the object.
- * @returns {Pick<T, U>} A new object with the specified keys picked.
+ * @param object - The object to pick keys from.
+ * @param props - An array of keys to be picked from the object.
+ * @returns A new object with the specified keys picked.
  *
  * @example
  * const obj = { a: 1, b: 2, c: 3 };
@@ -21,9 +21,9 @@ declare function pick<T extends object, U extends keyof T>(object: T, ...props:
  * Creates a new object composed of the picked object properties.
  *
  * @template T - The type of object.
- * @param {T | null | undefined} object - The object to pick keys from.
- * @param {...Array<Many<PropertyPath>>} props - An array of keys to be picked from the object.
- * @returns {Partial<T>} A new object with the specified keys picked.
+ * @param object - The object to pick keys from.
+ * @param props - An array of keys to be picked from the object.
+ * @returns A new object with the specified keys picked.
  *
  * @example
  * const obj = { a: 1, b: 2, c: 3 };

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

@@ -7,9 +7,9 @@ import { PropertyPath } from "../_internal/PropertyPath.js";
  *
  * @template T - The type of object.
  * @template U - The type of keys to pick.
- * @param {T} object - The object to pick keys from.
- * @param {...Array<Many<U>>} props - An array of keys to be picked from the object.
- * @returns {Pick<T, U>} A new object with the specified keys picked.
+ * @param object - The object to pick keys from.
+ * @param props - An array of keys to be picked from the object.
+ * @returns A new object with the specified keys picked.
  *
  * @example
  * const obj = { a: 1, b: 2, c: 3 };
@@ -21,9 +21,9 @@ declare function pick<T extends object, U extends keyof T>(object: T, ...props:
  * Creates a new object composed of the picked object properties.
  *
  * @template T - The type of object.
- * @param {T | null | undefined} object - The object to pick keys from.
- * @param {...Array<Many<PropertyPath>>} props - An array of keys to be picked from the object.
- * @returns {Partial<T>} A new object with the specified keys picked.
+ * @param object - The object to pick keys from.
+ * @param props - An array of keys to be picked from the object.
+ * @returns A new object with the specified keys picked.
  *
  * @example
  * const obj = { a: 1, b: 2, c: 3 };

package/dist/compat/object/pick.js

@@ -12,9 +12,9 @@ const require_set = require("./set.js");
 *
 * @template T - The type of object.
 * @template U - The type of keys to pick.
-* @param {T | any | null | undefined} object - The object to pick keys from.
-* @param {...Array<Many<U>> | Array<Many<PropertyPath>>} props - An array of keys to be picked from the object. received keys goes through a flattening process before being used.
-* @returns {Pick<T, U> | Partial<T>} A new object with the specified keys picked.
+* @param object - The object to pick keys from.
+* @param props - An array of keys to be picked from the object. received keys goes through a flattening process before being used.
+* @returns A new object with the specified keys picked.
 *
 * @example
 * const obj = { a: 1, b: 2, c: 3 };

package/dist/compat/object/pick.mjs

@@ -12,9 +12,9 @@ import { set } from "./set.mjs";
 *
 * @template T - The type of object.
 * @template U - The type of keys to pick.
-* @param {T | any | null | undefined} object - The object to pick keys from.
-* @param {...Array<Many<U>> | Array<Many<PropertyPath>>} props - An array of keys to be picked from the object. received keys goes through a flattening process before being used.
-* @returns {Pick<T, U> | Partial<T>} A new object with the specified keys picked.
+* @param object - The object to pick keys from.
+* @param props - An array of keys to be picked from the object. received keys goes through a flattening process before being used.
+* @returns A new object with the specified keys picked.
 *
 * @example
 * const obj = { a: 1, b: 2, c: 3 };

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

@@ -7,9 +7,9 @@ import { ValueKeyIterateeTypeGuard } from "../_internal/ValueKeyIterateeTypeGuar
  *
  * @template T - The type of object values.
  * @template S - The type of filtered values.
- * @param {Record<string, T> | null | undefined} object - The source object.
- * @param {ValueKeyIterateeTypeGuard<T, S>} predicate - The function invoked per property.
- * @returns {Record<string, S>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const users = {
@@ -25,9 +25,9 @@ declare function pickBy<T, S extends T>(object: Record<string, T> | null | undef
  *
  * @template T - The type of object values.
  * @template S - The type of filtered values.
- * @param {Record<number, T> | null | undefined} object - The source object.
- * @param {ValueKeyIterateeTypeGuard<T, S>} predicate - The function invoked per property.
- * @returns {Record<number, S>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const array = [1, 2, 3, 4];
@@ -39,9 +39,9 @@ declare function pickBy<T, S extends T>(object: Record<number, T> | null | undef
  * Creates a new object composed of the properties that satisfy the predicate function.
  *
  * @template T - The type of object values.
- * @param {Record<string, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} [predicate] - The function invoked per property.
- * @returns {Record<string, T>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param [predicate] - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const object = { 'a': 1, 'b': '2', 'c': 3 };
@@ -53,9 +53,9 @@ declare function pickBy<T>(object: Record<string, T> | null | undefined, predica
  * Creates a new object composed of the properties that satisfy the predicate function.
  *
  * @template T - The type of object values.
- * @param {Record<number, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} [predicate] - The function invoked per property.
- * @returns {Record<number, T>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param [predicate] - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const array = [1, 2, 3, 4];
@@ -67,9 +67,9 @@ declare function pickBy<T>(object: Record<number, T> | null | undefined, predica
  * Creates a new object composed of the properties that satisfy the predicate function.
  *
  * @template T - The type of object.
- * @param {T | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T[keyof T]>} [predicate] - The function invoked per property.
- * @returns {Partial<T>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param [predicate] - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const object = { 'a': 1, 'b': '2', 'c': 3 };

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

@@ -7,9 +7,9 @@ import { ValueKeyIterateeTypeGuard } from "../_internal/ValueKeyIterateeTypeGuar
  *
  * @template T - The type of object values.
  * @template S - The type of filtered values.
- * @param {Record<string, T> | null | undefined} object - The source object.
- * @param {ValueKeyIterateeTypeGuard<T, S>} predicate - The function invoked per property.
- * @returns {Record<string, S>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const users = {
@@ -25,9 +25,9 @@ declare function pickBy<T, S extends T>(object: Record<string, T> | null | undef
  *
  * @template T - The type of object values.
  * @template S - The type of filtered values.
- * @param {Record<number, T> | null | undefined} object - The source object.
- * @param {ValueKeyIterateeTypeGuard<T, S>} predicate - The function invoked per property.
- * @returns {Record<number, S>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const array = [1, 2, 3, 4];
@@ -39,9 +39,9 @@ declare function pickBy<T, S extends T>(object: Record<number, T> | null | undef
  * Creates a new object composed of the properties that satisfy the predicate function.
  *
  * @template T - The type of object values.
- * @param {Record<string, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} [predicate] - The function invoked per property.
- * @returns {Record<string, T>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param [predicate] - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const object = { 'a': 1, 'b': '2', 'c': 3 };
@@ -53,9 +53,9 @@ declare function pickBy<T>(object: Record<string, T> | null | undefined, predica
  * Creates a new object composed of the properties that satisfy the predicate function.
  *
  * @template T - The type of object values.
- * @param {Record<number, T> | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T>} [predicate] - The function invoked per property.
- * @returns {Record<number, T>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param [predicate] - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const array = [1, 2, 3, 4];
@@ -67,9 +67,9 @@ declare function pickBy<T>(object: Record<number, T> | null | undefined, predica
  * Creates a new object composed of the properties that satisfy the predicate function.
  *
  * @template T - The type of object.
- * @param {T | null | undefined} object - The source object.
- * @param {ValueKeyIteratee<T[keyof T]>} [predicate] - The function invoked per property.
- * @returns {Partial<T>} Returns the new filtered object.
+ * @param object - The source object.
+ * @param [predicate] - The function invoked per property.
+ * @returns Returns the new filtered object.
  *
  * @example
  * const object = { 'a': 1, 'b': '2', 'c': 3 };

package/dist/compat/object/pickBy.js

@@ -13,11 +13,11 @@ const require_getSymbolsIn = require("../_internal/getSymbolsIn.js");
 * includes only the properties for which the predicate function returns true.
 *
 * @template T - The type of object.
-* @param {Record<string, T> | Record<number, T> | object | null | undefined} obj - The object to pick properties from.
-* @param {ValueKeyIterateeTypeGuard<T, S> | ValueKeyIteratee<T[keyof T]> | ValueKeyIteratee<T>} [shouldPick] - A predicate function that determines
+* @param obj - The object to pick properties from.
+* @param [shouldPick] - A predicate function that determines
 * whether a property should be picked. It takes the property's key and value as arguments and returns `true`
 * if the property should be picked, and `false` otherwise.
-* @returns {Record<string, S> | Record<number, S> | Partial<T>} A new object with the properties that satisfy the predicate function.
+* @returns A new object with the properties that satisfy the predicate function.
 *
 * @example
 * const obj = { a: 1, b: 'pick', c: 3 };

package/dist/compat/object/pickBy.mjs

@@ -13,11 +13,11 @@ import { getSymbolsIn } from "../_internal/getSymbolsIn.mjs";
 * includes only the properties for which the predicate function returns true.
 *
 * @template T - The type of object.
-* @param {Record<string, T> | Record<number, T> | object | null | undefined} obj - The object to pick properties from.
-* @param {ValueKeyIterateeTypeGuard<T, S> | ValueKeyIteratee<T[keyof T]> | ValueKeyIteratee<T>} [shouldPick] - A predicate function that determines
+* @param obj - The object to pick properties from.
+* @param [shouldPick] - A predicate function that determines
 * whether a property should be picked. It takes the property's key and value as arguments and returns `true`
 * if the property should be picked, and `false` otherwise.
-* @returns {Record<string, S> | Record<number, S> | Partial<T>} A new object with the properties that satisfy the predicate function.
+* @returns A new object with the properties that satisfy the predicate function.
 *
 * @example
 * const obj = { a: 1, b: 'pick', c: 3 };

package/dist/compat/object/property.js

@@ -5,8 +5,8 @@ const require_get = require("./get.js");
 *
 * @template T - The type of object.
 * @template R - The type of the value to return.
-* @param {PropertyPath} path - The path of the property to get.
-* @returns {(object: T) => R} - Returns a new function that takes an object and returns the value at the specified path.
+* @param path - The path of the property to get.
+* @returns Returns a new function that takes an object and returns the value at the specified path.
 *
 * @example
 * const getObjectValue = property('a.b.c');

package/dist/compat/object/property.mjs

@@ -5,8 +5,8 @@ import { get } from "./get.mjs";
 *
 * @template T - The type of object.
 * @template R - The type of the value to return.
-* @param {PropertyPath} path - The path of the property to get.
-* @returns {(object: T) => R} - Returns a new function that takes an object and returns the value at the specified path.
+* @param path - The path of the property to get.
+* @returns Returns a new function that takes an object and returns the value at the specified path.
 *
 * @example
 * const getObjectValue = property('a.b.c');

package/dist/compat/object/propertyOf.js

@@ -7,8 +7,8 @@ const require_get = require("./get.js");
 * `propertyOf` creates a function bound to a specific object and allows you to query different paths within that object.
 *
 * @template T - The type of object.
-* @param {T} object - The object to query.
-* @returns {(path: PropertyPath) => any} - Returns a new function that takes a path and retrieves the value from the object at the specified path.
+* @param object - The object to query.
+* @returns Returns a new function that takes a path and retrieves the value from the object at the specified path.
 *
 * @example
 * const getValue = propertyOf({ a: { b: { c: 3 } } });

package/dist/compat/object/propertyOf.mjs

@@ -7,8 +7,8 @@ import { get } from "./get.mjs";
 * `propertyOf` creates a function bound to a specific object and allows you to query different paths within that object.
 *
 * @template T - The type of object.
-* @param {T} object - The object to query.
-* @returns {(path: PropertyPath) => any} - Returns a new function that takes a path and retrieves the value from the object at the specified path.
+* @param object - The object to query.
+* @returns Returns a new function that takes a path and retrieves the value from the object at the specified path.
 *
 * @example
 * const getValue = propertyOf({ a: { b: { c: 3 } } });

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

@@ -8,10 +8,10 @@ import { PropertyPath } from "../_internal/PropertyPath.mjs";
  *
  * @template T - The type of object.
  * @template R - The type of the value to return.
- * @param {T} object - The object to query.
- * @param {PropertyPath} path - The path of the property to get.
- * @param {R | ((...args: any[]) => R)} [defaultValue] - The value returned if the resolved value is `undefined`.
- * @returns {R} - 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 obj = { a: { b: { c: 3 } } };

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

@@ -8,10 +8,10 @@ import { PropertyPath } from "../_internal/PropertyPath.js";
  *
  * @template T - The type of object.
  * @template R - The type of the value to return.
- * @param {T} object - The object to query.
- * @param {PropertyPath} path - The path of the property to get.
- * @param {R | ((...args: any[]) => R)} [defaultValue] - The value returned if the resolved value is `undefined`.
- * @returns {R} - 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 obj = { a: { b: { c: 3 } } };

package/dist/compat/object/result.js

@@ -10,10 +10,10 @@ const require_isKey = require("../_internal/isKey.js");
 *
 * @template T - The type of object.
 * @template R - The type of the value to return.
-* @param {T} object - The object to query.
-* @param {PropertyPath} path - The path of the property to get.
-* @param {R | ((...args: any[]) => R)} [defaultValue] - The value returned if the resolved value is `undefined`.
-* @returns {R} - 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 obj = { a: { b: { c: 3 } } };

package/dist/compat/object/result.mjs

@@ -10,10 +10,10 @@ import { isKey } from "../_internal/isKey.mjs";
 *
 * @template T - The type of object.
 * @template R - The type of the value to return.
-* @param {T} object - The object to query.
-* @param {PropertyPath} path - The path of the property to get.
-* @param {R | ((...args: any[]) => R)} [defaultValue] - The value returned if the resolved value is `undefined`.
-* @returns {R} - 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 obj = { a: { b: { c: 3 } } };

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

@@ -5,10 +5,10 @@ import { PropertyPath } from "../_internal/PropertyPath.mjs";
  * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
  *
  * @template T - The type of the object.
- * @param {T} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @returns {T} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @returns The modified object.
  *
  * @example
  * // Set a value in a nested object
@@ -33,10 +33,10 @@ declare function set<T extends object>(object: T, path: PropertyPath, value: any
  * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
  *
  * @template R - The return type.
- * @param {object} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @returns {R} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @returns The modified object.
  *
  * @example
  * // Set a value in a nested object

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

@@ -5,10 +5,10 @@ import { PropertyPath } from "../_internal/PropertyPath.js";
  * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
  *
  * @template T - The type of the object.
- * @param {T} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @returns {T} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @returns The modified object.
  *
  * @example
  * // Set a value in a nested object
@@ -33,10 +33,10 @@ declare function set<T extends object>(object: T, path: PropertyPath, value: any
  * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
  *
  * @template R - The return type.
- * @param {object} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @returns {R} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @returns The modified object.
  *
  * @example
  * // Set a value in a nested object

package/dist/compat/object/set.js

@@ -4,10 +4,10 @@ const require_updateWith = require("./updateWith.js");
 * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
 *
 * @template T - The type of the object.
-* @param {T} obj - The object to modify.
-* @param {PropertyPath} path - The path of the property to set.
-* @param {any} value - The value to set.
-* @returns {T} - The modified object.
+* @param obj - The object to modify.
+* @param path - The path of the property to set.
+* @param value - The value to set.
+* @returns The modified object.
 *
 * @example
 * // Set a value in a nested object

package/dist/compat/object/set.mjs

@@ -4,10 +4,10 @@ import { updateWith } from "./updateWith.mjs";
 * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
 *
 * @template T - The type of the object.
-* @param {T} obj - The object to modify.
-* @param {PropertyPath} path - The path of the property to set.
-* @param {any} value - The value to set.
-* @returns {T} - The modified object.
+* @param obj - The object to modify.
+* @param path - The path of the property to set.
+* @param value - The value to set.
+* @returns The modified object.
 *
 * @example
 * // Set a value in a nested object

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

@@ -11,11 +11,11 @@ import { PropertyPath } from "../_internal/PropertyPath.mjs";
  * if the next path segment is a valid array index, or an object otherwise.
  *
  * @template T - The type of the object.
- * @param {T} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @param {(nsValue: any, key: string, nsObject: T) => any} [customizer] - The function to customize assigned values.
- * @returns {T} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @param [customizer] - The function to customize assigned values.
+ * @returns The modified object.
  *
  * @example
  * // Set a value with a customizer that creates arrays for numeric path segments
@@ -35,11 +35,11 @@ declare function setWith<T extends object>(object: T, path: PropertyPath, value:
  *
  * @template T - The type of the object.
  * @template R - The type of the return value.
- * @param {T} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @param {(nsValue: any, key: string, nsObject: T) => any} [customizer] - The function to customize assigned values.
- * @returns {R} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @param [customizer] - The function to customize assigned values.
+ * @returns The modified object.
  *
  * @example
  * // Set a value with a customizer that creates arrays for numeric path segments

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

@@ -11,11 +11,11 @@ import { PropertyPath } from "../_internal/PropertyPath.js";
  * if the next path segment is a valid array index, or an object otherwise.
  *
  * @template T - The type of the object.
- * @param {T} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @param {(nsValue: any, key: string, nsObject: T) => any} [customizer] - The function to customize assigned values.
- * @returns {T} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @param [customizer] - The function to customize assigned values.
+ * @returns The modified object.
  *
  * @example
  * // Set a value with a customizer that creates arrays for numeric path segments
@@ -35,11 +35,11 @@ declare function setWith<T extends object>(object: T, path: PropertyPath, value:
  *
  * @template T - The type of the object.
  * @template R - The type of the return value.
- * @param {T} object - The object to modify.
- * @param {PropertyPath} path - The path of the property to set.
- * @param {any} value - The value to set.
- * @param {(nsValue: any, key: string, nsObject: T) => any} [customizer] - The function to customize assigned values.
- * @returns {R} - The modified object.
+ * @param object - The object to modify.
+ * @param path - The path of the property to set.
+ * @param value - The value to set.
+ * @param [customizer] - The function to customize assigned values.
+ * @returns The modified object.
  *
  * @example
  * // Set a value with a customizer that creates arrays for numeric path segments