es-toolkit 1.47.0 → 1.47.1-dev.1853

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

@@ -8,8 +8,8 @@
  * - If the value is `null` or `undefined`, an empty array is returned.
  * - When handling prototype objects, the `constructor` property is excluded from the results.
  *
- * @param {any} [object] - The object to inspect for keys.
- * @returns {string[]} An array of string keys from the object.
+ * @param [object] - The object to inspect for keys.
+ * @returns An array of string keys from the object.
  *
  * @example
  * const obj = { a: 1, b: 2 };

package/dist/compat/object/keysIn.js

@@ -13,8 +13,8 @@ const require_times = require("../util/times.js");
 * - If the value is `null` or `undefined`, an empty array is returned.
 * - When handling prototype objects, the `constructor` property is excluded from the results.
 *
-* @param {any} [object] - The object to inspect for keys.
-* @returns {string[]} An array of string keys from the object.
+* @param [object] - The object to inspect for keys.
+* @returns An array of string keys from the object.
 *
 * @example
 * const obj = { a: 1, b: 2 };

package/dist/compat/object/keysIn.mjs

@@ -13,8 +13,8 @@ import { times } from "../util/times.mjs";
 * - If the value is `null` or `undefined`, an empty array is returned.
 * - When handling prototype objects, the `constructor` property is excluded from the results.
 *
-* @param {any} [object] - The object to inspect for keys.
-* @returns {string[]} An array of string keys from the object.
+* @param [object] - The object to inspect for keys.
+* @returns An array of string keys from the object.
 *
 * @example
 * const obj = { a: 1, b: 2 };

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

@@ -6,9 +6,9 @@ import { ObjectIteratee } from "../_internal/ObjectIteratee.mjs";
  * Creates an object with the same values as `object` and keys generated by running each own enumerable string keyed property through `iteratee`.
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} object - The object to iterate over.
- * @param {ValueIteratee<T>} [iteratee] - The function invoked per iteration.
- * @returns {Record<string, T>} - Returns the new mapped object.
+ * @param object - The object to iterate over.
+ * @param [iteratee] - The function invoked per iteration.
+ * @returns Returns the new mapped object.
  *
  * @example
  * mapKeys([1, 2, 3], (value, index) => `key${index}`);
@@ -19,9 +19,9 @@ declare function mapKeys<T>(object: ArrayLike<T> | null | undefined, iteratee?:
  * Creates an object with the same values as `object` and keys generated by running each own enumerable string keyed property through `iteratee`.
  *
  * @template T
- * @param {T | null | undefined} object - The object to iterate over.
- * @param {ValueIteratee<T[keyof T]>} [iteratee] - The function invoked per iteration.
- * @returns {Record<string, T[keyof T]>} - Returns the new mapped object.
+ * @param object - The object to iterate over.
+ * @param [iteratee] - The function invoked per iteration.
+ * @returns Returns the new mapped object.
  *
  * @example
  * mapKeys({ a: 1, b: 2 }, (value, key) => key + value);

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

@@ -6,9 +6,9 @@ import { ObjectIteratee } from "../_internal/ObjectIteratee.js";
  * Creates an object with the same values as `object` and keys generated by running each own enumerable string keyed property through `iteratee`.
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} object - The object to iterate over.
- * @param {ValueIteratee<T>} [iteratee] - The function invoked per iteration.
- * @returns {Record<string, T>} - Returns the new mapped object.
+ * @param object - The object to iterate over.
+ * @param [iteratee] - The function invoked per iteration.
+ * @returns Returns the new mapped object.
  *
  * @example
  * mapKeys([1, 2, 3], (value, index) => `key${index}`);
@@ -19,9 +19,9 @@ declare function mapKeys<T>(object: ArrayLike<T> | null | undefined, iteratee?:
  * Creates an object with the same values as `object` and keys generated by running each own enumerable string keyed property through `iteratee`.
  *
  * @template T
- * @param {T | null | undefined} object - The object to iterate over.
- * @param {ValueIteratee<T[keyof T]>} [iteratee] - The function invoked per iteration.
- * @returns {Record<string, T[keyof T]>} - Returns the new mapped object.
+ * @param object - The object to iterate over.
+ * @param [iteratee] - The function invoked per iteration.
+ * @returns Returns the new mapped object.
  *
  * @example
  * mapKeys({ a: 1, b: 2 }, (value, key) => key + value);

package/dist/compat/object/mapKeys.js

@@ -10,9 +10,9 @@ const require_iteratee = require("../util/iteratee.js");
 * @template K1 - The type of the keys in the object.
 * @template K2 - The type of the new keys generated by the iteratee function.
 *
-* @param {T} object - The object to iterate over.
-* @param {(value: T[K1], key: K1, object: T) => K2} [getNewKey] - The function invoked per own enumerable property, or a path to generate new keys.
-* @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+* @param object - The object to iterate over.
+* @param [getNewKey] - The function invoked per own enumerable property, or a path to generate new keys.
+* @returns Returns the new mapped object.
 *
 * @example
 * // Example usage:

package/dist/compat/object/mapKeys.mjs

@@ -10,9 +10,9 @@ import { iteratee } from "../util/iteratee.mjs";
 * @template K1 - The type of the keys in the object.
 * @template K2 - The type of the new keys generated by the iteratee function.
 *
-* @param {T} object - The object to iterate over.
-* @param {(value: T[K1], key: K1, object: T) => K2} [getNewKey] - The function invoked per own enumerable property, or a path to generate new keys.
-* @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+* @param object - The object to iterate over.
+* @param [getNewKey] - The function invoked per own enumerable property, or a path to generate new keys.
+* @returns Returns the new mapped object.
 *
 * @example
 * // Example usage:

package/dist/compat/object/mapValues.js

@@ -10,10 +10,10 @@ const require_iteratee = require("../util/iteratee.js");
 * @template K - The type of the keys in the object.
 * @template V - The type of the new values generated by the iteratee function.
 *
-* @param {T} object - The object to iterate over.
-* @param {(value: T[K], key: K, object: T) => V | PropertyKey | readonly PropertyKey[] | null | undefined} [getNewValue] -
+* @param object - The object to iterate over.
+* @param [getNewValue] -
 *        The function invoked per own enumerable property, or a path to generate new values.
-* @returns {Record<K, V>} - Returns the new mapped object.
+* @returns Returns the new mapped object.
 *
 * @example
 * // Example usage:

package/dist/compat/object/mapValues.mjs

@@ -10,10 +10,10 @@ import { iteratee } from "../util/iteratee.mjs";
 * @template K - The type of the keys in the object.
 * @template V - The type of the new values generated by the iteratee function.
 *
-* @param {T} object - The object to iterate over.
-* @param {(value: T[K], key: K, object: T) => V | PropertyKey | readonly PropertyKey[] | null | undefined} [getNewValue] -
+* @param object - The object to iterate over.
+* @param [getNewValue] -
 *        The function invoked per own enumerable property, or a path to generate new values.
-* @returns {Record<K, V>} - Returns the new mapped object.
+* @returns Returns the new mapped object.
 *
 * @example
 * // Example usage:

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

@@ -4,9 +4,9 @@
  *
  * @template T
  * @template U
- * @param {T} object - The destination object.
- * @param {U} source - The source object.
- * @returns {T & U} - Returns `object`.
+ * @param object - The destination object.
+ * @param source - The source object.
+ * @returns Returns `object`.
  *
  * @example
  * const object = { a: [{ b: 2 }, { d: 4 }] };
@@ -21,10 +21,10 @@ declare function merge<T, U>(object: T, source: U): T & U;
  * @template T
  * @template U
  * @template V
- * @param {T} object - The destination object.
- * @param {U} source1 - The first source object.
- * @param {V} source2 - The second source object.
- * @returns {T & U & V} - Returns `object`.
+ * @param object - The destination object.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 });
@@ -38,11 +38,11 @@ declare function merge<T, U, V>(object: T, source1: U, source2: V): T & U & V;
  * @template U
  * @template V
  * @template W
- * @param {T} object - The destination object.
- * @param {U} source1 - The first source object.
- * @param {V} source2 - The second source object.
- * @param {W} source3 - The third source object.
- * @returns {T & U & V & W} - Returns `object`.
+ * @param object - The destination object.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 }, { d: 4 });
@@ -57,12 +57,12 @@ declare function merge<T, U, V, W>(object: T, source1: U, source2: V, source3: W
  * @template V
  * @template W
  * @template X
- * @param {T} object - The destination object.
- * @param {U} source1 - The first source object.
- * @param {V} source2 - The second source object.
- * @param {W} source3 - The third source object.
- * @param {X} source4 - The fourth source object.
- * @returns {T & U & V & W & X} - Returns `object`.
+ * @param object - The destination object.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @param source4 - The fourth source object.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 }, { d: 4 }, { e: 5 });
@@ -72,9 +72,9 @@ declare function merge<T, U, V, W, X>(object: T, source1: U, source2: V, source3
 /**
  * Recursively merges own and inherited enumerable string keyed properties of source objects into the destination object.
  *
- * @param {any} object - The destination object.
- * @param {...any[]} otherArgs - The source objects.
- * @returns {any} - Returns `object`.
+ * @param object - The destination object.
+ * @param otherArgs - The source objects.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 });

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

@@ -4,9 +4,9 @@
  *
  * @template T
  * @template U
- * @param {T} object - The destination object.
- * @param {U} source - The source object.
- * @returns {T & U} - Returns `object`.
+ * @param object - The destination object.
+ * @param source - The source object.
+ * @returns Returns `object`.
  *
  * @example
  * const object = { a: [{ b: 2 }, { d: 4 }] };
@@ -21,10 +21,10 @@ declare function merge<T, U>(object: T, source: U): T & U;
  * @template T
  * @template U
  * @template V
- * @param {T} object - The destination object.
- * @param {U} source1 - The first source object.
- * @param {V} source2 - The second source object.
- * @returns {T & U & V} - Returns `object`.
+ * @param object - The destination object.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 });
@@ -38,11 +38,11 @@ declare function merge<T, U, V>(object: T, source1: U, source2: V): T & U & V;
  * @template U
  * @template V
  * @template W
- * @param {T} object - The destination object.
- * @param {U} source1 - The first source object.
- * @param {V} source2 - The second source object.
- * @param {W} source3 - The third source object.
- * @returns {T & U & V & W} - Returns `object`.
+ * @param object - The destination object.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 }, { d: 4 });
@@ -57,12 +57,12 @@ declare function merge<T, U, V, W>(object: T, source1: U, source2: V, source3: W
  * @template V
  * @template W
  * @template X
- * @param {T} object - The destination object.
- * @param {U} source1 - The first source object.
- * @param {V} source2 - The second source object.
- * @param {W} source3 - The third source object.
- * @param {X} source4 - The fourth source object.
- * @returns {T & U & V & W & X} - Returns `object`.
+ * @param object - The destination object.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @param source4 - The fourth source object.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 }, { d: 4 }, { e: 5 });
@@ -72,9 +72,9 @@ declare function merge<T, U, V, W, X>(object: T, source1: U, source2: V, source3
 /**
  * Recursively merges own and inherited enumerable string keyed properties of source objects into the destination object.
  *
- * @param {any} object - The destination object.
- * @param {...any[]} otherArgs - The source objects.
- * @returns {any} - Returns `object`.
+ * @param object - The destination object.
+ * @param otherArgs - The source objects.
+ * @returns Returns `object`.
  *
  * @example
  * merge({ a: 1 }, { b: 2 }, { c: 3 });

package/dist/compat/object/merge.js

@@ -10,9 +10,9 @@ const require_mergeWith = require("./mergeWith.js");
 *
 * The function can handle multiple source objects and will merge them all into the target object.
 *
-* @param {any} object - The target object into which the source object properties will be merged. This object is modified in place.
-* @param {any[]} sources - The source objects whose properties will be merged into the target object.
-* @returns {any} The updated target object with properties from the source object(s) merged in.
+* @param object - The target object into which the source object properties will be merged. This object is modified in place.
+* @param sources - The source objects whose properties will be merged into the target object.
+* @returns The updated target object with properties from the source object(s) merged in.
 *
 * @example
 * const target = { a: 1, b: { x: 1, y: 2 } };

package/dist/compat/object/merge.mjs

@@ -10,9 +10,9 @@ import { mergeWith } from "./mergeWith.mjs";
 *
 * The function can handle multiple source objects and will merge them all into the target object.
 *
-* @param {any} object - The target object into which the source object properties will be merged. This object is modified in place.
-* @param {any[]} sources - The source objects whose properties will be merged into the target object.
-* @returns {any} The updated target object with properties from the source object(s) merged in.
+* @param object - The target object into which the source object properties will be merged. This object is modified in place.
+* @param sources - The source objects whose properties will be merged into the target object.
+* @returns The updated target object with properties from the source object(s) merged in.
 *
 * @example
 * const target = { a: 1, b: { x: 1, y: 2 } };

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

@@ -5,10 +5,10 @@ type MergeWithCustomizer = (objValue: any, srcValue: any, key: string, object: a
  *
  * @template TObject
  * @template TSource
- * @param {TObject} object - The target object into which the source object properties will be merged.
- * @param {TSource} source - The source object whose properties will be merged into the target object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource} Returns the updated target object with properties from the source object merged in.
+ * @param object - The target object into which the source object properties will be merged.
+ * @param source - The source object whose properties will be merged into the target object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source object merged in.
  *
  * @example
  * const target = { a: 1, b: 2 };
@@ -28,11 +28,11 @@ declare function mergeWith<TObject, TSource>(object: TObject, source: TSource, c
  * @template TObject
  * @template TSource1
  * @template TSource2
- * @param {TObject} object - The target object into which the source objects properties will be merged.
- * @param {TSource1} source1 - The first source object.
- * @param {TSource2} source2 - The second source object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource1 & TSource2} Returns the updated target object with properties from the source objects merged in.
+ * @param object - The target object into which the source objects properties will be merged.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source objects merged in.
  *
  * @example
  * const target = { a: 1 };
@@ -54,12 +54,12 @@ declare function mergeWith<TObject, TSource1, TSource2>(object: TObject, source1
  * @template TSource1
  * @template TSource2
  * @template TSource3
- * @param {TObject} object - The target object into which the source objects properties will be merged.
- * @param {TSource1} source1 - The first source object.
- * @param {TSource2} source2 - The second source object.
- * @param {TSource3} source3 - The third source object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource1 & TSource2 & TSource3} Returns the updated target object with properties from the source objects merged in.
+ * @param object - The target object into which the source objects properties will be merged.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source objects merged in.
  *
  * @example
  * const target = { a: 1 };
@@ -83,13 +83,13 @@ declare function mergeWith<TObject, TSource1, TSource2, TSource3>(object: TObjec
  * @template TSource2
  * @template TSource3
  * @template TSource4
- * @param {TObject} object - The target object into which the source objects properties will be merged.
- * @param {TSource1} source1 - The first source object.
- * @param {TSource2} source2 - The second source object.
- * @param {TSource3} source3 - The third source object.
- * @param {TSource4} source4 - The fourth source object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource1 & TSource2 & TSource3 & TSource4} Returns the updated target object with properties from the source objects merged in.
+ * @param object - The target object into which the source objects properties will be merged.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @param source4 - The fourth source object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source objects merged in.
  *
  * @example
  * const target = { a: 1 };
@@ -109,9 +109,9 @@ declare function mergeWith<TObject, TSource1, TSource2, TSource3, TSource4>(obje
 /**
  * Merges the properties of one or more source objects into the target object.
  *
- * @param {any} object - The target object into which the source object properties will be merged.
- * @param {...any} otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
- * @returns {any} The updated target object with properties from the source object(s) merged in.
+ * @param object - The target object into which the source object properties will be merged.
+ * @param otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
+ * @returns The updated target object with properties from the source object(s) merged in.
  *
  * @example
  * const target = { a: 1, b: 2 };

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

@@ -5,10 +5,10 @@ type MergeWithCustomizer = (objValue: any, srcValue: any, key: string, object: a
  *
  * @template TObject
  * @template TSource
- * @param {TObject} object - The target object into which the source object properties will be merged.
- * @param {TSource} source - The source object whose properties will be merged into the target object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource} Returns the updated target object with properties from the source object merged in.
+ * @param object - The target object into which the source object properties will be merged.
+ * @param source - The source object whose properties will be merged into the target object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source object merged in.
  *
  * @example
  * const target = { a: 1, b: 2 };
@@ -28,11 +28,11 @@ declare function mergeWith<TObject, TSource>(object: TObject, source: TSource, c
  * @template TObject
  * @template TSource1
  * @template TSource2
- * @param {TObject} object - The target object into which the source objects properties will be merged.
- * @param {TSource1} source1 - The first source object.
- * @param {TSource2} source2 - The second source object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource1 & TSource2} Returns the updated target object with properties from the source objects merged in.
+ * @param object - The target object into which the source objects properties will be merged.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source objects merged in.
  *
  * @example
  * const target = { a: 1 };
@@ -54,12 +54,12 @@ declare function mergeWith<TObject, TSource1, TSource2>(object: TObject, source1
  * @template TSource1
  * @template TSource2
  * @template TSource3
- * @param {TObject} object - The target object into which the source objects properties will be merged.
- * @param {TSource1} source1 - The first source object.
- * @param {TSource2} source2 - The second source object.
- * @param {TSource3} source3 - The third source object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource1 & TSource2 & TSource3} Returns the updated target object with properties from the source objects merged in.
+ * @param object - The target object into which the source objects properties will be merged.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source objects merged in.
  *
  * @example
  * const target = { a: 1 };
@@ -83,13 +83,13 @@ declare function mergeWith<TObject, TSource1, TSource2, TSource3>(object: TObjec
  * @template TSource2
  * @template TSource3
  * @template TSource4
- * @param {TObject} object - The target object into which the source objects properties will be merged.
- * @param {TSource1} source1 - The first source object.
- * @param {TSource2} source2 - The second source object.
- * @param {TSource3} source3 - The third source object.
- * @param {TSource4} source4 - The fourth source object.
- * @param {MergeWithCustomizer} customizer - The function to customize assigned values.
- * @returns {TObject & TSource1 & TSource2 & TSource3 & TSource4} Returns the updated target object with properties from the source objects merged in.
+ * @param object - The target object into which the source objects properties will be merged.
+ * @param source1 - The first source object.
+ * @param source2 - The second source object.
+ * @param source3 - The third source object.
+ * @param source4 - The fourth source object.
+ * @param customizer - The function to customize assigned values.
+ * @returns Returns the updated target object with properties from the source objects merged in.
  *
  * @example
  * const target = { a: 1 };
@@ -109,9 +109,9 @@ declare function mergeWith<TObject, TSource1, TSource2, TSource3, TSource4>(obje
 /**
  * Merges the properties of one or more source objects into the target object.
  *
- * @param {any} object - The target object into which the source object properties will be merged.
- * @param {...any} otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
- * @returns {any} The updated target object with properties from the source object(s) merged in.
+ * @param object - The target object into which the source object properties will be merged.
+ * @param otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
+ * @returns The updated target object with properties from the source object(s) merged in.
  *
  * @example
  * const target = { a: 1, b: 2 };

package/dist/compat/object/mergeWith.js

@@ -30,9 +30,9 @@ const require_isTypedArray = require("../predicate/isTypedArray.js");
 *
 * The function can handle multiple source objects and will merge them all into the target object.
 *
-* @param {any} object - The target object into which the source object properties will be merged. This object is modified in place.
-* @param {...any} otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
-* @returns {any} The updated target object with properties from the source object(s) merged in.
+* @param object - The target object into which the source object properties will be merged. This object is modified in place.
+* @param otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
+* @returns The updated target object with properties from the source object(s) merged in.
 *
 * @example
 * const target = { a: 1, b: 2 };

package/dist/compat/object/mergeWith.mjs

@@ -30,9 +30,9 @@ import { isTypedArray } from "../predicate/isTypedArray.mjs";
 *
 * The function can handle multiple source objects and will merge them all into the target object.
 *
-* @param {any} object - The target object into which the source object properties will be merged. This object is modified in place.
-* @param {...any} otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
-* @returns {any} The updated target object with properties from the source object(s) merged in.
+* @param object - The target object into which the source object properties will be merged. This object is modified in place.
+* @param otherArgs - Additional source objects to merge into the target object, including the custom `merge` function.
+* @returns The updated target object with properties from the source object(s) merged in.
 *
 * @example
 * const target = { a: 1, b: 2 };

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

@@ -6,9 +6,9 @@ import { Many } from "../_internal/Many.mjs";
  *
  * @template T - The type of object.
  * @template K - The type of keys to omit.
- * @param {T | null | undefined} object - The object to omit keys from.
- * @param {...K} paths - The keys to be omitted from the object.
- * @returns {Pick<T, Exclude<keyof T, K[number]>>} A new object with the specified keys omitted.
+ * @param object - The object to omit keys from.
+ * @param paths - The keys to be omitted from the object.
+ * @returns A new object with the specified keys omitted.
  *
  * @example
  * omit({ a: 1, b: 2, c: 3 }, 'a', 'c');
@@ -20,9 +20,9 @@ declare function omit<T extends object, K extends PropertyKey[]>(object: T | nul
  *
  * @template T - The type of object.
  * @template K - The type of keys to omit.
- * @param {T | null | undefined} object - The object to omit keys from.
- * @param {...Array<Many<K>>} paths - The keys to be omitted from the object.
- * @returns {Omit<T, K>} A new object with the specified keys omitted.
+ * @param object - The object to omit keys from.
+ * @param paths - The keys to be omitted from the object.
+ * @returns A new object with the specified keys omitted.
  *
  * @example
  * omit({ a: 1, b: 2, c: 3 }, 'a', ['b', 'c']);
@@ -33,9 +33,9 @@ declare function omit<T extends object, K extends keyof T>(object: T | null | un
  * Creates a new object with specified keys omitted.
  *
  * @template T - The type of object.
- * @param {T | null | undefined} object - The object to omit keys from.
- * @param {...Array<Many<PropertyKey>>} paths - The keys to be omitted from the object.
- * @returns {Partial<T>} A new object with the specified keys omitted.
+ * @param object - The object to omit keys from.
+ * @param paths - The keys to be omitted from the object.
+ * @returns A new object with the specified keys omitted.
  *
  * @example
  * omit({ a: 1, b: 2, c: 3 }, 'a', 'b');

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

@@ -6,9 +6,9 @@ import { Many } from "../_internal/Many.js";
  *
  * @template T - The type of object.
  * @template K - The type of keys to omit.
- * @param {T | null | undefined} object - The object to omit keys from.
- * @param {...K} paths - The keys to be omitted from the object.
- * @returns {Pick<T, Exclude<keyof T, K[number]>>} A new object with the specified keys omitted.
+ * @param object - The object to omit keys from.
+ * @param paths - The keys to be omitted from the object.
+ * @returns A new object with the specified keys omitted.
  *
  * @example
  * omit({ a: 1, b: 2, c: 3 }, 'a', 'c');
@@ -20,9 +20,9 @@ declare function omit<T extends object, K extends PropertyKey[]>(object: T | nul
  *
  * @template T - The type of object.
  * @template K - The type of keys to omit.
- * @param {T | null | undefined} object - The object to omit keys from.
- * @param {...Array<Many<K>>} paths - The keys to be omitted from the object.
- * @returns {Omit<T, K>} A new object with the specified keys omitted.
+ * @param object - The object to omit keys from.
+ * @param paths - The keys to be omitted from the object.
+ * @returns A new object with the specified keys omitted.
  *
  * @example
  * omit({ a: 1, b: 2, c: 3 }, 'a', ['b', 'c']);
@@ -33,9 +33,9 @@ declare function omit<T extends object, K extends keyof T>(object: T | null | un
  * Creates a new object with specified keys omitted.
  *
  * @template T - The type of object.
- * @param {T | null | undefined} object - The object to omit keys from.
- * @param {...Array<Many<PropertyKey>>} paths - The keys to be omitted from the object.
- * @returns {Partial<T>} A new object with the specified keys omitted.
+ * @param object - The object to omit keys from.
+ * @param paths - The keys to be omitted from the object.
+ * @returns A new object with the specified keys omitted.
  *
  * @example
  * omit({ a: 1, b: 2, c: 3 }, 'a', 'b');

package/dist/compat/object/omit.js

@@ -15,9 +15,9 @@ const require_getSymbolsIn = require("../_internal/getSymbolsIn.js");
 * Deep keys can be specified for keys.
 *
 * @template T - The type of object.
-* @param {T | null | undefined} obj - The object to omit keys from.
-* @param {...Array<Many<PropertyKey>> | Array<Many<PropertyKey[]>>} keysArr - A variable number of keys to be omitted from the object.
-* @returns {Partial<T>} A new object with the specified keys omitted.
+* @param obj - The object to omit keys from.
+* @param keysArr - A variable number of keys to be omitted from the object.
+* @returns A new object with the specified keys omitted.
 *
 * @example
 * omit({ a: 1, b: 2, c: 3 }, 'a', 'b');

package/dist/compat/object/omit.mjs

@@ -15,9 +15,9 @@ import { getSymbolsIn } from "../_internal/getSymbolsIn.mjs";
 * Deep keys can be specified for keys.
 *
 * @template T - The type of object.
-* @param {T | null | undefined} obj - The object to omit keys from.
-* @param {...Array<Many<PropertyKey>> | Array<Many<PropertyKey[]>>} keysArr - A variable number of keys to be omitted from the object.
-* @returns {Partial<T>} A new object with the specified keys omitted.
+* @param obj - The object to omit keys from.
+* @param keysArr - A variable number of keys to be omitted from the object.
+* @returns A new object with the specified keys omitted.
 *
 * @example
 * omit({ a: 1, b: 2, c: 3 }, 'a', 'b');