es-toolkit 1.47.0 → 1.47.1

package/dist/compat/object/setWith.js

@@ -11,11 +11,11 @@ const require_updateWith = require("./updateWith.js");
 *
 * @template T - The type of the object.
 * @template R - The type of the return value.
-* @param {T} obj - The object to modify.
-* @param {PropertyPath} path - The path of the property to set.
-* @param {any} value - The value to set.
-* @param {(value: any, key: string, object: T) => any} [customizer] - The function to customize assigned values.
-* @returns {T | R} - The modified object.
+* @param obj - 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.mjs

@@ -11,11 +11,11 @@ import { updateWith } from "./updateWith.mjs";
 *
 * @template T - The type of the object.
 * @template R - The type of the return value.
-* @param {T} obj - The object to modify.
-* @param {PropertyPath} path - The path of the property to set.
-* @param {any} value - The value to set.
-* @param {(value: any, key: string, object: T) => any} [customizer] - The function to customize assigned values.
-* @returns {T | R} - The modified object.
+* @param obj - 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/toDefaulted.d.mts

@@ -12,8 +12,8 @@
  * Note: This function creates a new object. If you want to modify the `object`, use the `defaults` function instead.
  *
  * @template T - The type of the object being processed.
- * @param {T} object - The target object.
- * @returns {T} The cloned object.
+ * @param object - The target object.
+ * @returns The cloned object.
  */
 declare function toDefaulted<T extends object>(object: T): T;
 /**
@@ -28,9 +28,9 @@ declare function toDefaulted<T extends object>(object: T): T;
  *
  * @template T - The type of the object being processed.
  * @template S - The type of the object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S} source - The object that specifies the default values to apply.
- * @returns {NonNullable<T & S>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source - The object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S extends object>(object: T, source: S): NonNullable<T & S>;
 /**
@@ -46,10 +46,10 @@ declare function toDefaulted<T extends object, S extends object>(object: T, sour
  * @template T - The type of the object being processed.
  * @template S1 - The type of the first object that provides default values.
  * @template S2 - The type of the second object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S1} source1 - The first object that specifies the default values to apply.
- * @param {S2} source2 - The second object that specifies the default values to apply.
- * @returns {NonNullable<T & S1 & S2>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source1 - The first object that specifies the default values to apply.
+ * @param source2 - The second object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S1 extends object, S2 extends object>(object: T, source1: S1, source2: S2): NonNullable<T & S1 & S2>;
 /**
@@ -66,11 +66,11 @@ declare function toDefaulted<T extends object, S1 extends object, S2 extends obj
  * @template S1 - The type of the first object that provides default values.
  * @template S2 - The type of the second object that provides default values.
  * @template S3 - The type of the third object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S1} source1 - The first object that specifies the default values to apply.
- * @param {S2} source2 - The second object that specifies the default values to apply.
- * @param {S3} source3 - The third object that specifies the default values to apply.
- * @returns {NonNullable<T & S1 & S2 & S3>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source1 - The first object that specifies the default values to apply.
+ * @param source2 - The second object that specifies the default values to apply.
+ * @param source3 - The third object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S1 extends object, S2 extends object, S3 extends object>(object: T, source1: S1, source2: S2, source3: S3): NonNullable<T & S1 & S2 & S3>;
 /**
@@ -88,12 +88,12 @@ declare function toDefaulted<T extends object, S1 extends object, S2 extends obj
  * @template S2 - The type of the second object that provides default values.
  * @template S3 - The type of the third object that provides default values.
  * @template S4 - The type of the fourth object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S1} source1 - The first object that specifies the default values to apply.
- * @param {S2} source2 - The second object that specifies the default values to apply.
- * @param {S3} source3 - The third object that specifies the default values to apply.
- * @param {S4} source4 - The fourth object that specifies the default values to apply.
- * @returns {NonNullable<T & S1 & S2 & S3 & S4>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source1 - The first object that specifies the default values to apply.
+ * @param source2 - The second object that specifies the default values to apply.
+ * @param source3 - The third object that specifies the default values to apply.
+ * @param source4 - The fourth object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S1 extends object, S2 extends object, S3 extends object, S4 extends object>(object: T, source1: S1, source2: S2, source3: S3, source4: S4): NonNullable<T & S1 & S2 & S3 & S4>;
 /**
@@ -108,9 +108,9 @@ declare function toDefaulted<T extends object, S1 extends object, S2 extends obj
  *
  * @template T - The type of the object being processed.
  * @template S - The type of the objects that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S[]} sources - The objects that specifies the default values to apply.
- * @returns {object} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param sources - The objects that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  *
  * @example
  * toDefaulted({ a: 1 }, { a: 2, b: 2 }, { c: 3 }); // { a: 1, b: 2, c: 3 }

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

@@ -12,8 +12,8 @@
  * Note: This function creates a new object. If you want to modify the `object`, use the `defaults` function instead.
  *
  * @template T - The type of the object being processed.
- * @param {T} object - The target object.
- * @returns {T} The cloned object.
+ * @param object - The target object.
+ * @returns The cloned object.
  */
 declare function toDefaulted<T extends object>(object: T): T;
 /**
@@ -28,9 +28,9 @@ declare function toDefaulted<T extends object>(object: T): T;
  *
  * @template T - The type of the object being processed.
  * @template S - The type of the object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S} source - The object that specifies the default values to apply.
- * @returns {NonNullable<T & S>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source - The object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S extends object>(object: T, source: S): NonNullable<T & S>;
 /**
@@ -46,10 +46,10 @@ declare function toDefaulted<T extends object, S extends object>(object: T, sour
  * @template T - The type of the object being processed.
  * @template S1 - The type of the first object that provides default values.
  * @template S2 - The type of the second object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S1} source1 - The first object that specifies the default values to apply.
- * @param {S2} source2 - The second object that specifies the default values to apply.
- * @returns {NonNullable<T & S1 & S2>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source1 - The first object that specifies the default values to apply.
+ * @param source2 - The second object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S1 extends object, S2 extends object>(object: T, source1: S1, source2: S2): NonNullable<T & S1 & S2>;
 /**
@@ -66,11 +66,11 @@ declare function toDefaulted<T extends object, S1 extends object, S2 extends obj
  * @template S1 - The type of the first object that provides default values.
  * @template S2 - The type of the second object that provides default values.
  * @template S3 - The type of the third object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S1} source1 - The first object that specifies the default values to apply.
- * @param {S2} source2 - The second object that specifies the default values to apply.
- * @param {S3} source3 - The third object that specifies the default values to apply.
- * @returns {NonNullable<T & S1 & S2 & S3>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source1 - The first object that specifies the default values to apply.
+ * @param source2 - The second object that specifies the default values to apply.
+ * @param source3 - The third object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S1 extends object, S2 extends object, S3 extends object>(object: T, source1: S1, source2: S2, source3: S3): NonNullable<T & S1 & S2 & S3>;
 /**
@@ -88,12 +88,12 @@ declare function toDefaulted<T extends object, S1 extends object, S2 extends obj
  * @template S2 - The type of the second object that provides default values.
  * @template S3 - The type of the third object that provides default values.
  * @template S4 - The type of the fourth object that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S1} source1 - The first object that specifies the default values to apply.
- * @param {S2} source2 - The second object that specifies the default values to apply.
- * @param {S3} source3 - The third object that specifies the default values to apply.
- * @param {S4} source4 - The fourth object that specifies the default values to apply.
- * @returns {NonNullable<T & S1 & S2 & S3 & S4>} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param source1 - The first object that specifies the default values to apply.
+ * @param source2 - The second object that specifies the default values to apply.
+ * @param source3 - The third object that specifies the default values to apply.
+ * @param source4 - The fourth object that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  */
 declare function toDefaulted<T extends object, S1 extends object, S2 extends object, S3 extends object, S4 extends object>(object: T, source1: S1, source2: S2, source3: S3, source4: S4): NonNullable<T & S1 & S2 & S3 & S4>;
 /**
@@ -108,9 +108,9 @@ declare function toDefaulted<T extends object, S1 extends object, S2 extends obj
  *
  * @template T - The type of the object being processed.
  * @template S - The type of the objects that provides default values.
- * @param {T} object - The target object that will receive default values.
- * @param {S[]} sources - The objects that specifies the default values to apply.
- * @returns {object} A new object that combines the target and default values, ensuring no properties are left undefined.
+ * @param object - The target object that will receive default values.
+ * @param sources - The objects that specifies the default values to apply.
+ * @returns A new object that combines the target and default values, ensuring no properties are left undefined.
  *
  * @example
  * toDefaulted({ a: 1 }, { a: 2, b: 2 }, { c: 3 }); // { a: 1, b: 2, c: 3 }

package/dist/compat/object/toDefaulted.js

@@ -13,9 +13,9 @@ const require_defaults = require("./defaults.js");
 *
 * @template T - The type of the object being processed.
 * @template S - The type of the objects that provides default values.
-* @param {T} object - The target object that will receive default values.
-* @param {S[]} sources - The objects that specifies the default values to apply.
-* @returns {object} A new object that combines the target and default values, ensuring no properties are left undefined.
+* @param object - The target object that will receive default values.
+* @param sources - The objects that specifies the default values to apply.
+* @returns A new object that combines the target and default values, ensuring no properties are left undefined.
 *
 * @example
 * toDefaulted({ a: 1 }, { a: 2, b: 2 }, { c: 3 }); // { a: 1, b: 2, c: 3 }

package/dist/compat/object/toDefaulted.mjs

@@ -13,9 +13,9 @@ import { defaults } from "./defaults.mjs";
 *
 * @template T - The type of the object being processed.
 * @template S - The type of the objects that provides default values.
-* @param {T} object - The target object that will receive default values.
-* @param {S[]} sources - The objects that specifies the default values to apply.
-* @returns {object} A new object that combines the target and default values, ensuring no properties are left undefined.
+* @param object - The target object that will receive default values.
+* @param sources - The objects that specifies the default values to apply.
+* @returns A new object that combines the target and default values, ensuring no properties are left undefined.
 *
 * @example
 * toDefaulted({ a: 1 }, { a: 2, b: 2 }, { c: 3 }); // { a: 1, b: 2, c: 3 }

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

@@ -3,8 +3,8 @@
  * Creates an array of key-value pairs from an object.
  *
  * @template T
- * @param {Record<string, T> | Record<number, T>} object - The object to query.
- * @returns {Array<[string, T]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };
@@ -14,8 +14,8 @@ declare function toPairs<T>(object?: Record<string, T> | Record<number, T>): Arr
 /**
  * Creates an array of key-value pairs from an object.
  *
- * @param {object} object - The object to query.
- * @returns {Array<[string, any]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };

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

@@ -3,8 +3,8 @@
  * Creates an array of key-value pairs from an object.
  *
  * @template T
- * @param {Record<string, T> | Record<number, T>} object - The object to query.
- * @returns {Array<[string, T]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };
@@ -14,8 +14,8 @@ declare function toPairs<T>(object?: Record<string, T> | Record<number, T>): Arr
 /**
  * Creates an array of key-value pairs from an object.
  *
- * @param {object} object - The object to query.
- * @returns {Array<[string, any]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };

package/dist/compat/object/toPairs.js

@@ -6,8 +6,8 @@ const require_setToEntries = require("../_internal/setToEntries.js");
 * Creates an array of key-value pairs from an object, set, or map.
 *
 * @template T
-* @param {Record<string, T> | Record<number, T> | object} object - The object, set, or map to query.
-* @returns {Array<[string, T]> | Array<[string, any]>} Returns the array of key-value pairs.
+* @param object - The object, set, or map to query.
+* @returns Returns the array of key-value pairs.
 *
 * @example
 * const object = { a: 1, b: 2 };

package/dist/compat/object/toPairs.mjs

@@ -6,8 +6,8 @@ import { setToEntries } from "../_internal/setToEntries.mjs";
 * Creates an array of key-value pairs from an object, set, or map.
 *
 * @template T
-* @param {Record<string, T> | Record<number, T> | object} object - The object, set, or map to query.
-* @returns {Array<[string, T]> | Array<[string, any]>} Returns the array of key-value pairs.
+* @param object - The object, set, or map to query.
+* @returns Returns the array of key-value pairs.
 *
 * @example
 * const object = { a: 1, b: 2 };

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

@@ -3,8 +3,8 @@
  * Creates an array of key-value pairs from an object, including inherited properties.
  *
  * @template T
- * @param {Record<string, T> | Record<number, T>} object - The object to query.
- * @returns {Array<[string, T]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };
@@ -14,8 +14,8 @@ declare function toPairsIn<T>(object?: Record<string, T> | Record<number, T>): A
 /**
  * Creates an array of key-value pairs from an object, including inherited properties.
  *
- * @param {object} object - The object to query.
- * @returns {Array<[string, any]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };

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

@@ -3,8 +3,8 @@
  * Creates an array of key-value pairs from an object, including inherited properties.
  *
  * @template T
- * @param {Record<string, T> | Record<number, T>} object - The object to query.
- * @returns {Array<[string, T]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };
@@ -14,8 +14,8 @@ declare function toPairsIn<T>(object?: Record<string, T> | Record<number, T>): A
 /**
  * Creates an array of key-value pairs from an object, including inherited properties.
  *
- * @param {object} object - The object to query.
- * @returns {Array<[string, any]>} Returns the array of key-value pairs.
+ * @param object - The object to query.
+ * @returns Returns the array of key-value pairs.
  *
  * @example
  * const object = { a: 1, b: 2 };

package/dist/compat/object/toPairsIn.js

@@ -5,8 +5,8 @@ const require_setToEntries = require("../_internal/setToEntries.js");
 /**
 * Creates an array of key-value pairs from an object, set, or map, including inherited properties.
 *
-* @param {Record<string, T> | Record<number, T> | object} object The object, set, or map to query.
-* @returns {Array<[string, T]> | Array<[string, any]>} Returns the array of key-value pairs.
+* @param object The object, set, or map to query.
+* @returns Returns the array of key-value pairs.
 * @example
 * const object = { a: 1, b: 2 };
 * toPairsIn(object); // [['a', 1], ['b', 2]]

package/dist/compat/object/toPairsIn.mjs

@@ -5,8 +5,8 @@ import { setToEntries } from "../_internal/setToEntries.mjs";
 /**
 * Creates an array of key-value pairs from an object, set, or map, including inherited properties.
 *
-* @param {Record<string, T> | Record<number, T> | object} object The object, set, or map to query.
-* @returns {Array<[string, T]> | Array<[string, any]>} Returns the array of key-value pairs.
+* @param object The object, set, or map to query.
+* @returns Returns the array of key-value pairs.
 * @example
 * const object = { a: 1, b: 2 };
 * toPairsIn(object); // [['a', 1], ['b', 2]]

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

@@ -4,10 +4,10 @@
  *
  * @template T - The type of object.
  * @template R - The type of accumulator.
- * @param {readonly T[]} object - The array to iterate over.
- * @param {(acc: R, curr: T, index: number, arr: T[]) => void} iteratee - The function invoked per iteration.
- * @param {R} [accumulator] - The initial value.
- * @returns {R} Returns the accumulated value.
+ * @param object - The array to iterate over.
+ * @param iteratee - The function invoked per iteration.
+ * @param [accumulator] - The initial value.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const array = [2, 3, 4];
@@ -20,10 +20,10 @@ declare function transform<T, R>(object: readonly T[], iteratee: (acc: R, curr:
  *
  * @template T - The type of object.
  * @template R - The type of accumulator.
- * @param {Record<string, T>} object - The object to iterate over.
- * @param {(acc: R, curr: T, key: string, dict: Record<string, T>) => void} iteratee - The function invoked per iteration.
- * @param {R} [accumulator] - The initial value.
- * @returns {R} Returns the accumulated value.
+ * @param object - The object to iterate over.
+ * @param iteratee - The function invoked per iteration.
+ * @param [accumulator] - The initial value.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const obj = { 'a': 1, 'b': 2, 'c': 1 };
@@ -36,10 +36,10 @@ declare function transform<T, R>(object: Record<string, T>, iteratee: (acc: R, c
  *
  * @template T - The type of object.
  * @template R - The type of accumulator.
- * @param {T} object - The object to iterate over.
- * @param {(acc: R, curr: T[keyof T], key: keyof T, dict: Record<keyof T, T[keyof T]>) => void} iteratee - The function invoked per iteration.
- * @param {R} [accumulator] - The initial value.
- * @returns {R} Returns the accumulated value.
+ * @param object - The object to iterate over.
+ * @param iteratee - The function invoked per iteration.
+ * @param [accumulator] - The initial value.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const obj = { x: 1, y: 2, z: 3 };
@@ -50,8 +50,8 @@ declare function transform<T extends object, R>(object: T, iteratee: (acc: R, cu
 /**
  * Traverses object values and creates a new object by accumulating them in the desired form.
  *
- * @param {any[]} object - The array to iterate over.
- * @returns {any[]} Returns the accumulated value.
+ * @param object - The array to iterate over.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const array = [1, 2, 3];
@@ -62,8 +62,8 @@ declare function transform(object: any[]): any[];
 /**
  * Traverses object values and creates a new object by accumulating them in the desired form.
  *
- * @param {object} object - The object to iterate over.
- * @returns {Record<string, any>} Returns the accumulated value.
+ * @param object - The object to iterate over.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const obj = { a: 1, b: 2 };

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

@@ -4,10 +4,10 @@
  *
  * @template T - The type of object.
  * @template R - The type of accumulator.
- * @param {readonly T[]} object - The array to iterate over.
- * @param {(acc: R, curr: T, index: number, arr: T[]) => void} iteratee - The function invoked per iteration.
- * @param {R} [accumulator] - The initial value.
- * @returns {R} Returns the accumulated value.
+ * @param object - The array to iterate over.
+ * @param iteratee - The function invoked per iteration.
+ * @param [accumulator] - The initial value.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const array = [2, 3, 4];
@@ -20,10 +20,10 @@ declare function transform<T, R>(object: readonly T[], iteratee: (acc: R, curr:
  *
  * @template T - The type of object.
  * @template R - The type of accumulator.
- * @param {Record<string, T>} object - The object to iterate over.
- * @param {(acc: R, curr: T, key: string, dict: Record<string, T>) => void} iteratee - The function invoked per iteration.
- * @param {R} [accumulator] - The initial value.
- * @returns {R} Returns the accumulated value.
+ * @param object - The object to iterate over.
+ * @param iteratee - The function invoked per iteration.
+ * @param [accumulator] - The initial value.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const obj = { 'a': 1, 'b': 2, 'c': 1 };
@@ -36,10 +36,10 @@ declare function transform<T, R>(object: Record<string, T>, iteratee: (acc: R, c
  *
  * @template T - The type of object.
  * @template R - The type of accumulator.
- * @param {T} object - The object to iterate over.
- * @param {(acc: R, curr: T[keyof T], key: keyof T, dict: Record<keyof T, T[keyof T]>) => void} iteratee - The function invoked per iteration.
- * @param {R} [accumulator] - The initial value.
- * @returns {R} Returns the accumulated value.
+ * @param object - The object to iterate over.
+ * @param iteratee - The function invoked per iteration.
+ * @param [accumulator] - The initial value.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const obj = { x: 1, y: 2, z: 3 };
@@ -50,8 +50,8 @@ declare function transform<T extends object, R>(object: T, iteratee: (acc: R, cu
 /**
  * Traverses object values and creates a new object by accumulating them in the desired form.
  *
- * @param {any[]} object - The array to iterate over.
- * @returns {any[]} Returns the accumulated value.
+ * @param object - The array to iterate over.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const array = [1, 2, 3];
@@ -62,8 +62,8 @@ declare function transform(object: any[]): any[];
 /**
  * Traverses object values and creates a new object by accumulating them in the desired form.
  *
- * @param {object} object - The object to iterate over.
- * @returns {Record<string, any>} Returns the accumulated value.
+ * @param object - The object to iterate over.
+ * @returns Returns the accumulated value.
  *
  * @example
  * const obj = { a: 1, b: 2 };

package/dist/compat/object/transform.js

@@ -15,10 +15,10 @@ The traversal is interrupted when the `iteratee` function returns `false`.
 *
 * @template T - The type of object.
 * @template U - The type of accumulator.
-* @param {readonly T[] | T} object - The object to iterate over.
-* @param {(accumulator: U, value: T | T[keyof T], key: any, object: T[] | T) => unknown} [iteratee] - The function invoked per iteration.
-* @param {U} [accumulator] - The initial value.
-* @returns {U} Returns the accumulated value.
+* @param object - The object to iterate over.
+* @param [iteratee] - The function invoked per iteration.
+* @param [accumulator] - The initial value.
+* @returns Returns the accumulated value.
 *
 * @example
 * // Transform an array

package/dist/compat/object/transform.mjs

@@ -15,10 +15,10 @@ The traversal is interrupted when the `iteratee` function returns `false`.
 *
 * @template T - The type of object.
 * @template U - The type of accumulator.
-* @param {readonly T[] | T} object - The object to iterate over.
-* @param {(accumulator: U, value: T | T[keyof T], key: any, object: T[] | T) => unknown} [iteratee] - The function invoked per iteration.
-* @param {U} [accumulator] - The initial value.
-* @returns {U} Returns the accumulated value.
+* @param object - The object to iterate over.
+* @param [iteratee] - The function invoked per iteration.
+* @param [accumulator] - The initial value.
+* @returns Returns the accumulated value.
 *
 * @example
 * // Transform an array

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

@@ -2,9 +2,9 @@
 /**
  * Removes the property at the given path of the object.
  *
- * @param {unknown} obj - The object to modify.
- * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to unset.
- * @returns {boolean} - Returns true if the property is deleted, else false.
+ * @param obj - The object to modify.
+ * @param path - The path of the property to unset.
+ * @returns Returns true if the property is deleted, else false.
  *
  * @example
  * const obj = { a: { b: { c: 42 } } };

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

@@ -2,9 +2,9 @@
 /**
  * Removes the property at the given path of the object.
  *
- * @param {unknown} obj - The object to modify.
- * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to unset.
- * @returns {boolean} - Returns true if the property is deleted, else false.
+ * @param obj - The object to modify.
+ * @param path - The path of the property to unset.
+ * @returns Returns true if the property is deleted, else false.
  *
  * @example
  * const obj = { a: { b: { c: 42 } } };

package/dist/compat/object/unset.js

@@ -7,9 +7,9 @@ const require_get = require("./get.js");
 /**
 * Removes the property at the given path of the object.
 *
-* @param {unknown} obj - The object to modify.
-* @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to unset.
-* @returns {boolean} - Returns true if the property is deleted, else false.
+* @param obj - The object to modify.
+* @param path - The path of the property to unset.
+* @returns Returns true if the property is deleted, else false.
 *
 * @example
 * const obj = { a: { b: { c: 42 } } };

package/dist/compat/object/unset.mjs

@@ -7,9 +7,9 @@ import { get } from "./get.mjs";
 /**
 * Removes the property at the given path of the object.
 *
-* @param {unknown} obj - The object to modify.
-* @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to unset.
-* @returns {boolean} - Returns true if the property is deleted, else false.
+* @param obj - The object to modify.
+* @param path - The path of the property to unset.
+* @returns Returns true if the property is deleted, else false.
 *
 * @example
 * const obj = { a: { b: { c: 42 } } };

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

@@ -5,10 +5,10 @@ import { PropertyPath } from "../_internal/PropertyPath.mjs";
  * Updates the value at the specified path of the given object using an updater function.
  * If any part of the path does not exist, it will be created.
  *
- * @param {object} obj - The object to modify.
- * @param {PropertyPath} path - The path of the property to update.
- * @param {(value: any) => any} updater - The function to produce the updated value.
- * @returns {any} - The modified object.
+ * @param obj - The object to modify.
+ * @param path - The path of the property to update.
+ * @param updater - The function to produce the updated value.
+ * @returns The modified object.
  */
 declare function update(obj: object, path: PropertyPath, updater: (value: any) => any): any;
 //#endregion

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

@@ -5,10 +5,10 @@ import { PropertyPath } from "../_internal/PropertyPath.js";
  * Updates the value at the specified path of the given object using an updater function.
  * If any part of the path does not exist, it will be created.
  *
- * @param {object} obj - The object to modify.
- * @param {PropertyPath} path - The path of the property to update.
- * @param {(value: any) => any} updater - The function to produce the updated value.
- * @returns {any} - The modified object.
+ * @param obj - The object to modify.
+ * @param path - The path of the property to update.
+ * @param updater - The function to produce the updated value.
+ * @returns The modified object.
  */
 declare function update(obj: object, path: PropertyPath, updater: (value: any) => any): any;
 //#endregion