es-toolkit 1.47.0 → 1.47.1-dev.1853

package/dist/compat/array/groupBy.mjs

@@ -12,13 +12,13 @@ import { iteratee } from "../util/iteratee.mjs";
 *
 * @template T - The type of elements in the array or values in the object.
 * @template K - The type of keys.
-* @param {ArrayLike<T> | Record<any, T> | null | undefined} source - The collection to group.
-* @param {Function | PropertyKey | Array | Object} [_getKeyFromItem] - The iteratee to transform keys.
+* @param source - The collection to group.
+* @param [_getKeyFromItem] - The iteratee to transform keys.
 *   - If a function is provided, it's invoked for each element in the collection.
 *   - If a property name (string) is provided, that property of each element is used as the key.
 *   - If a property-value pair (array) is provided, elements with matching property values are used.
 *   - If a partial object is provided, elements with matching properties are used.
-* @returns {Record<K, T>} An object where each key is associated with an array of elements that
+* @returns An object where each key is associated with an array of elements that
 * share that key.
 *
 * @example

package/dist/compat/array/head.d.mts

@@ -3,8 +3,8 @@
  * Returns the first element of an array or `undefined` if the array is empty.
  *
  * @template T - The type of elements in the array.
- * @param {readonly [T, ...unknown[]]} array - A non-empty tuple with at least one element.
- * @returns {T} The first element of the array.
+ * @param array - A non-empty tuple with at least one element.
+ * @returns The first element of the array.
  *
  * @example
  * const arr = [1, 2, 3] as const;
@@ -16,8 +16,8 @@ declare function head<T>(array: readonly [T, ...unknown[]]): T;
  * Returns the first element of an array or `undefined` if the array is empty.
  *
  * @template T - The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} array - The array from which to get the first element.
- * @returns {T | undefined} The first element of the array, or `undefined` if the array is empty/null/undefined.
+ * @param array - The array from which to get the first element.
+ * @returns The first element of the array, or `undefined` if the array is empty/null/undefined.
  *
  * @example
  * const arr = [1, 2, 3];

package/dist/compat/array/head.d.ts

@@ -3,8 +3,8 @@
  * Returns the first element of an array or `undefined` if the array is empty.
  *
  * @template T - The type of elements in the array.
- * @param {readonly [T, ...unknown[]]} array - A non-empty tuple with at least one element.
- * @returns {T} The first element of the array.
+ * @param array - A non-empty tuple with at least one element.
+ * @returns The first element of the array.
  *
  * @example
  * const arr = [1, 2, 3] as const;
@@ -16,8 +16,8 @@ declare function head<T>(array: readonly [T, ...unknown[]]): T;
  * Returns the first element of an array or `undefined` if the array is empty.
  *
  * @template T - The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} array - The array from which to get the first element.
- * @returns {T | undefined} The first element of the array, or `undefined` if the array is empty/null/undefined.
+ * @param array - The array from which to get the first element.
+ * @returns The first element of the array, or `undefined` if the array is empty/null/undefined.
  *
  * @example
  * const arr = [1, 2, 3];

package/dist/compat/array/head.js

@@ -9,8 +9,8 @@ const require_isArrayLike = require("../predicate/isArrayLike.js");
 * If the array is empty, the function returns `undefined`.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | undefined | null} arr - The array from which to get the first element.
-* @returns {T | undefined} The first element of the array, or `undefined` if the array is empty.
+* @param arr - The array from which to get the first element.
+* @returns The first element of the array, or `undefined` if the array is empty.
 *
 * @example
 * const emptyArr: number[] = [];

package/dist/compat/array/head.mjs

@@ -9,8 +9,8 @@ import { isArrayLike } from "../predicate/isArrayLike.mjs";
 * If the array is empty, the function returns `undefined`.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | undefined | null} arr - The array from which to get the first element.
-* @returns {T | undefined} The first element of the array, or `undefined` if the array is empty.
+* @param arr - The array from which to get the first element.
+* @returns The first element of the array, or `undefined` if the array is empty.
 *
 * @example
 * const emptyArr: number[] = [];

package/dist/compat/array/includes.js

@@ -8,10 +8,10 @@ const require_isString = require("../predicate/isString.js");
 *
 * The comparison uses SameValueZero to check for inclusion.
 *
-* @param {T[] | Record<string, any> | string} source - The source to search in. It can be an array, an object, or a string.
-* @param {T} [target] - The value to search for in the source.
-* @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the source.
-* @returns {boolean} `true` if the value is found in the source, `false` otherwise.
+* @param source - The source to search in. It can be an array, an object, or a string.
+* @param [target] - The value to search for in the source.
+* @param [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the source.
+* @returns `true` if the value is found in the source, `false` otherwise.
 *
 * @example
 * includes([1, 2, 3], 2); // true

package/dist/compat/array/includes.mjs

@@ -8,10 +8,10 @@ import { isString } from "../predicate/isString.mjs";
 *
 * The comparison uses SameValueZero to check for inclusion.
 *
-* @param {T[] | Record<string, any> | string} source - The source to search in. It can be an array, an object, or a string.
-* @param {T} [target] - The value to search for in the source.
-* @param {number} [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the source.
-* @returns {boolean} `true` if the value is found in the source, `false` otherwise.
+* @param source - The source to search in. It can be an array, an object, or a string.
+* @param [target] - The value to search for in the source.
+* @param [fromIndex=0] - The index to start searching from. If negative, it is treated as an offset from the end of the source.
+* @returns `true` if the value is found in the source, `false` otherwise.
 *
 * @example
 * includes([1, 2, 3], 2); // true

package/dist/compat/array/indexOf.d.mts

@@ -6,10 +6,10 @@
  * It uses strict equality (`===`) to compare elements.
  *
  * @template T - The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} array - The array to search.
- * @param {T} searchElement - The value to search for.
- * @param {number} [fromIndex] - The index to start the search at.
- * @returns {number} The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
+ * @param array - The array to search.
+ * @param searchElement - The value to search for.
+ * @param [fromIndex] - The index to start the search at.
+ * @returns The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
  *
  * @example
  * const array = [1, 2, 3, NaN];

package/dist/compat/array/indexOf.d.ts

@@ -6,10 +6,10 @@
  * It uses strict equality (`===`) to compare elements.
  *
  * @template T - The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} array - The array to search.
- * @param {T} searchElement - The value to search for.
- * @param {number} [fromIndex] - The index to start the search at.
- * @returns {number} The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
+ * @param array - The array to search.
+ * @param searchElement - The value to search for.
+ * @param [fromIndex] - The index to start the search at.
+ * @returns The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
  *
  * @example
  * const array = [1, 2, 3, NaN];

package/dist/compat/array/indexOf.js

@@ -7,10 +7,10 @@ const require_isArrayLike = require("../predicate/isArrayLike.js");
 * It uses strict equality (`===`) to compare elements.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | null | undefined} array - The array to search.
-* @param {T} searchElement - The value to search for.
-* @param {number} [fromIndex] - The index to start the search at.
-* @returns {number} The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
+* @param array - The array to search.
+* @param searchElement - The value to search for.
+* @param [fromIndex] - The index to start the search at.
+* @returns The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
 *
 * @example
 * const array = [1, 2, 3, NaN];

package/dist/compat/array/indexOf.mjs

@@ -7,10 +7,10 @@ import { isArrayLike } from "../predicate/isArrayLike.mjs";
 * It uses strict equality (`===`) to compare elements.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | null | undefined} array - The array to search.
-* @param {T} searchElement - The value to search for.
-* @param {number} [fromIndex] - The index to start the search at.
-* @returns {number} The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
+* @param array - The array to search.
+* @param searchElement - The value to search for.
+* @param [fromIndex] - The index to start the search at.
+* @returns The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
 *
 * @example
 * const array = [1, 2, 3, NaN];

package/dist/compat/array/initial.d.mts

@@ -4,8 +4,8 @@
  * If the input array is empty or has only one element, the function returns an empty array.
  *
  * @template T The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} arr - The input array.
- * @returns {T[]} A new array containing all but the last element of the input array.
+ * @param arr - The input array.
+ * @returns A new array containing all but the last element of the input array.
  *
  * @example
  * const arr = [1, 2, 3, 4];

package/dist/compat/array/initial.d.ts

@@ -4,8 +4,8 @@
  * If the input array is empty or has only one element, the function returns an empty array.
  *
  * @template T The type of elements in the array.
- * @param {ArrayLike<T> | null | undefined} arr - The input array.
- * @returns {T[]} A new array containing all but the last element of the input array.
+ * @param arr - The input array.
+ * @returns A new array containing all but the last element of the input array.
  *
  * @example
  * const arr = [1, 2, 3, 4];

package/dist/compat/array/initial.js

@@ -6,8 +6,8 @@ const require_isArrayLike = require("../predicate/isArrayLike.js");
 * If the input array is empty or has only one element, the function returns an empty array.
 *
 * @template T The type of elements in the array.
-* @param {ArrayLike<T> | null | undefined} arr - The input array.
-* @returns {T[]} A new array containing all but the last element of the input array.
+* @param arr - The input array.
+* @returns A new array containing all but the last element of the input array.
 *
 * @example
 * const arr = [1, 2, 3, 4];

package/dist/compat/array/initial.mjs

@@ -6,8 +6,8 @@ import { isArrayLike } from "../predicate/isArrayLike.mjs";
 * If the input array is empty or has only one element, the function returns an empty array.
 *
 * @template T The type of elements in the array.
-* @param {ArrayLike<T> | null | undefined} arr - The input array.
-* @returns {T[]} A new array containing all but the last element of the input array.
+* @param arr - The input array.
+* @returns A new array containing all but the last element of the input array.
 *
 * @example
 * const arr = [1, 2, 3, 4];

package/dist/compat/array/intersection.d.mts

@@ -7,8 +7,8 @@
  * in every array.
  *
  * @template T - The type of elements in the arrays.
- * @param {...(ArrayLike<T> | null | undefined)} arrays - The arrays to compare.
- * @returns {T[]} A new array containing the elements that are present in all arrays.
+ * @param arrays - The arrays to compare.
+ * @returns A new array containing the elements that are present in all arrays.
  *
  * @example
  * const array1 = [1, 2, 3, 4, 5];

package/dist/compat/array/intersection.d.ts

@@ -7,8 +7,8 @@
  * in every array.
  *
  * @template T - The type of elements in the arrays.
- * @param {...(ArrayLike<T> | null | undefined)} arrays - The arrays to compare.
- * @returns {T[]} A new array containing the elements that are present in all arrays.
+ * @param arrays - The arrays to compare.
+ * @returns A new array containing the elements that are present in all arrays.
  *
  * @example
  * const array1 = [1, 2, 3, 4, 5];

package/dist/compat/array/intersection.js

@@ -10,8 +10,8 @@ const require_isArrayLikeObject = require("../predicate/isArrayLikeObject.js");
 * in every array.
 *
 * @template T - The type of elements in the arrays.
-* @param {...(ArrayLike<T> | null | undefined)} arrays - The arrays to compare.
-* @returns {T[]} A new array containing the elements that are present in all arrays.
+* @param arrays - The arrays to compare.
+* @returns A new array containing the elements that are present in all arrays.
 *
 * @example
 * const array1 = [1, 2, 3, 4, 5];

package/dist/compat/array/intersection.mjs

@@ -10,8 +10,8 @@ import { isArrayLikeObject } from "../predicate/isArrayLikeObject.mjs";
 * in every array.
 *
 * @template T - The type of elements in the arrays.
-* @param {...(ArrayLike<T> | null | undefined)} arrays - The arrays to compare.
-* @returns {T[]} A new array containing the elements that are present in all arrays.
+* @param arrays - The arrays to compare.
+* @returns A new array containing the elements that are present in all arrays.
 *
 * @example
 * const array1 = [1, 2, 3, 4, 5];

package/dist/compat/array/intersectionBy.d.mts

@@ -5,10 +5,10 @@ import { ValueIteratee } from "../_internal/ValueIteratee.mjs";
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T, U
- * @param {ArrayLike<T> | null} array - The array to inspect.
- * @param {ArrayLike<U>} values - The values to compare.
- * @param {ValueIteratee<T | U>} iteratee - The iteratee invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values - The values to compare.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor);
@@ -19,11 +19,11 @@ declare function intersectionBy<T, U>(array: ArrayLike<T> | null, values: ArrayL
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T, U, V
- * @param {ArrayLike<T> | null} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {ValueIteratee<T | U | V>} iteratee - The iteratee invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], [2.5], Math.floor);
@@ -34,11 +34,11 @@ declare function intersectionBy<T, U, V>(array: ArrayLike<T> | null, values1: Ar
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T, U, V, W
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {...Array<ArrayLike<W> | ValueIteratee<T | U | V | W>>} values - The other arrays to compare, and the iteratee to use.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param values - The other arrays to compare, and the iteratee to use.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], [2.5], [2.6, 1.7], Math.floor);
@@ -49,9 +49,9 @@ declare function intersectionBy<T, U, V, W>(array: ArrayLike<T> | null | undefin
  * Creates an array of unique values that are included in all given arrays.
  *
  * @template T
- * @param {ArrayLike<T> | null} [array] - The array to inspect.
- * @param {...Array<ArrayLike<T>>} values - The values to compare.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param [array] - The array to inspect.
+ * @param values - The values to compare.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2, 1], [2, 3]);
@@ -62,8 +62,8 @@ declare function intersectionBy<T>(array?: ArrayLike<T> | null, ...values: Array
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T
- * @param {...Array<ArrayLike<T> | ValueIteratee<T>>} values - The arrays to compare and the iteratee to use.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param values - The arrays to compare and the iteratee to use.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor);

package/dist/compat/array/intersectionBy.d.ts

@@ -5,10 +5,10 @@ import { ValueIteratee } from "../_internal/ValueIteratee.js";
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T, U
- * @param {ArrayLike<T> | null} array - The array to inspect.
- * @param {ArrayLike<U>} values - The values to compare.
- * @param {ValueIteratee<T | U>} iteratee - The iteratee invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values - The values to compare.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor);
@@ -19,11 +19,11 @@ declare function intersectionBy<T, U>(array: ArrayLike<T> | null, values: ArrayL
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T, U, V
- * @param {ArrayLike<T> | null} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {ValueIteratee<T | U | V>} iteratee - The iteratee invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], [2.5], Math.floor);
@@ -34,11 +34,11 @@ declare function intersectionBy<T, U, V>(array: ArrayLike<T> | null, values1: Ar
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T, U, V, W
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {...Array<ArrayLike<W> | ValueIteratee<T | U | V | W>>} values - The other arrays to compare, and the iteratee to use.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param values - The other arrays to compare, and the iteratee to use.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], [2.5], [2.6, 1.7], Math.floor);
@@ -49,9 +49,9 @@ declare function intersectionBy<T, U, V, W>(array: ArrayLike<T> | null | undefin
  * Creates an array of unique values that are included in all given arrays.
  *
  * @template T
- * @param {ArrayLike<T> | null} [array] - The array to inspect.
- * @param {...Array<ArrayLike<T>>} values - The values to compare.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param [array] - The array to inspect.
+ * @param values - The values to compare.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2, 1], [2, 3]);
@@ -62,8 +62,8 @@ declare function intersectionBy<T>(array?: ArrayLike<T> | null, ...values: Array
  * Creates an array of unique values that are included in all given arrays, using an iteratee to compute equality.
  *
  * @template T
- * @param {...Array<ArrayLike<T> | ValueIteratee<T>>} values - The arrays to compare and the iteratee to use.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param values - The arrays to compare and the iteratee to use.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor);

package/dist/compat/array/intersectionBy.js

@@ -16,9 +16,9 @@ const require_isArrayLikeObject = require("../predicate/isArrayLikeObject.js");
 * If the first array is `null` or `undefined`, an empty array is returned.
 *
 * @template T
-* @param {ArrayLike<T> | null | undefined} array - The first array to compare.
-* @param {...(ArrayLike<T> | ((value: T) => unknown) | string)} values - The arrays to compare, or the iteratee function.
-* @returns {T[]} A new array containing the elements from the first array that are present
+* @param array - The first array to compare.
+* @param values - The arrays to compare, or the iteratee function.
+* @returns A new array containing the elements from the first array that are present
 *  in all subsequent arrays after applying the iteratee.
 *
 * @example

package/dist/compat/array/intersectionBy.mjs

@@ -16,9 +16,9 @@ import { isArrayLikeObject } from "../predicate/isArrayLikeObject.mjs";
 * If the first array is `null` or `undefined`, an empty array is returned.
 *
 * @template T
-* @param {ArrayLike<T> | null | undefined} array - The first array to compare.
-* @param {...(ArrayLike<T> | ((value: T) => unknown) | string)} values - The arrays to compare, or the iteratee function.
-* @returns {T[]} A new array containing the elements from the first array that are present
+* @param array - The first array to compare.
+* @param values - The arrays to compare, or the iteratee function.
+* @returns A new array containing the elements from the first array that are present
 *  in all subsequent arrays after applying the iteratee.
 *
 * @example

package/dist/compat/array/intersectionWith.d.mts

@@ -3,10 +3,10 @@
  * Creates an array of unique values that are included in all given arrays, using a comparator function for equality comparisons.
  *
  * @template T, U
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values - The values to compare.
- * @param {(a: T, b: T | U) => boolean} comparator - The comparator invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values - The values to compare.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
@@ -19,11 +19,11 @@ declare function intersectionWith<T, U>(array: ArrayLike<T> | null | undefined,
  * Creates an array of unique values that are included in all given arrays, using a comparator function for equality comparisons.
  *
  * @template T, U, V
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {(a: T, b: T | U | V) => boolean} comparator - The comparator invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
@@ -37,11 +37,11 @@ declare function intersectionWith<T, U, V>(array: ArrayLike<T> | null | undefine
  * Creates an array of unique values that are included in all given arrays, using a comparator function for equality comparisons.
  *
  * @template T, U, V, W
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {...Array<ArrayLike<W> | (a: T, b: T | U | V | W) => boolean>} values - The other arrays to compare, and the comparator to use.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param values - The other arrays to compare, and the comparator to use.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
@@ -56,9 +56,9 @@ declare function intersectionWith<T, U, V, W>(array: ArrayLike<T> | null | undef
  * Creates an array of unique values that are included in all given arrays.
  *
  * @template T
- * @param {ArrayLike<T> | null} [array] - The array to inspect.
- * @param {...Array<ArrayLike<T> | (a: T, b: never) => boolean>} values - The values to compare.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param [array] - The array to inspect.
+ * @param values - The values to compare.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionWith([2, 1], [2, 3]);

package/dist/compat/array/intersectionWith.d.ts

@@ -3,10 +3,10 @@
  * Creates an array of unique values that are included in all given arrays, using a comparator function for equality comparisons.
  *
  * @template T, U
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values - The values to compare.
- * @param {(a: T, b: T | U) => boolean} comparator - The comparator invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values - The values to compare.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
@@ -19,11 +19,11 @@ declare function intersectionWith<T, U>(array: ArrayLike<T> | null | undefined,
  * Creates an array of unique values that are included in all given arrays, using a comparator function for equality comparisons.
  *
  * @template T, U, V
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {(a: T, b: T | U | V) => boolean} comparator - The comparator invoked per element.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
@@ -37,11 +37,11 @@ declare function intersectionWith<T, U, V>(array: ArrayLike<T> | null | undefine
  * Creates an array of unique values that are included in all given arrays, using a comparator function for equality comparisons.
  *
  * @template T, U, V, W
- * @param {ArrayLike<T> | null | undefined} array - The array to inspect.
- * @param {ArrayLike<U>} values1 - The first values to compare.
- * @param {ArrayLike<V>} values2 - The second values to compare.
- * @param {...Array<ArrayLike<W> | (a: T, b: T | U | V | W) => boolean>} values - The other arrays to compare, and the comparator to use.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param array - The array to inspect.
+ * @param values1 - The first values to compare.
+ * @param values2 - The second values to compare.
+ * @param values - The other arrays to compare, and the comparator to use.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
@@ -56,9 +56,9 @@ declare function intersectionWith<T, U, V, W>(array: ArrayLike<T> | null | undef
  * Creates an array of unique values that are included in all given arrays.
  *
  * @template T
- * @param {ArrayLike<T> | null} [array] - The array to inspect.
- * @param {...Array<ArrayLike<T> | (a: T, b: never) => boolean>} values - The values to compare.
- * @returns {T[]} Returns the new array of intersecting values.
+ * @param [array] - The array to inspect.
+ * @param values - The values to compare.
+ * @returns Returns the new array of intersecting values.
  *
  * @example
  * intersectionWith([2, 1], [2, 3]);

package/dist/compat/array/intersectionWith.js

@@ -8,9 +8,9 @@ const require_uniq = require("./uniq.js");
 * Returns the intersection of multiple arrays based on a custom equality function.
 *
 * @template T - The type of elements in the arrays
-* @param {ArrayLike<T> | null | undefined} firstArr - The first array to compare
-* @param {...(ArrayLike<T> | null | undefined | ((x: T, y: T) => boolean))} otherArrs - Additional arrays and optional equality function
-* @returns {T[]} Elements from first array that match in all arrays
+* @param firstArr - The first array to compare
+* @param otherArrs - Additional arrays and optional equality function
+* @returns Elements from first array that match in all arrays
 *
 * @example
 * const arr1 = [{id: 1}, {id: 2}];

package/dist/compat/array/intersectionWith.mjs

@@ -8,9 +8,9 @@ import { uniq } from "./uniq.mjs";
 * Returns the intersection of multiple arrays based on a custom equality function.
 *
 * @template T - The type of elements in the arrays
-* @param {ArrayLike<T> | null | undefined} firstArr - The first array to compare
-* @param {...(ArrayLike<T> | null | undefined | ((x: T, y: T) => boolean))} otherArrs - Additional arrays and optional equality function
-* @returns {T[]} Elements from first array that match in all arrays
+* @param firstArr - The first array to compare
+* @param otherArrs - Additional arrays and optional equality function
+* @returns Elements from first array that match in all arrays
 *
 * @example
 * const arr1 = [{id: 1}, {id: 2}];