es-toolkit 1.47.0 → 1.47.1-dev.1851

package/dist/array/uniqBy.d.mts

@@ -7,9 +7,9 @@
  *
  * @template T - The type of elements in the array.
  * @template U - The type of mapped elements.
- * @param {T[]} arr - The array to process.
- * @param {(item: T) => U} mapper - The function used to convert the array elements.
- * @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
+ * @param arr - The array to process.
+ * @param mapper - The function used to convert the array elements.
+ * @returns A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
  *
  * @example
  * ```ts

package/dist/array/uniqBy.d.ts

@@ -7,9 +7,9 @@
  *
  * @template T - The type of elements in the array.
  * @template U - The type of mapped elements.
- * @param {T[]} arr - The array to process.
- * @param {(item: T) => U} mapper - The function used to convert the array elements.
- * @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
+ * @param arr - The array to process.
+ * @param mapper - The function used to convert the array elements.
+ * @returns A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
  *
  * @example
  * ```ts

package/dist/array/uniqBy.js

@@ -7,9 +7,9 @@
 *
 * @template T - The type of elements in the array.
 * @template U - The type of mapped elements.
-* @param {T[]} arr - The array to process.
-* @param {(item: T) => U} mapper - The function used to convert the array elements.
-* @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
+* @param arr - The array to process.
+* @param mapper - The function used to convert the array elements.
+* @returns A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
 *
 * @example
 * ```ts

package/dist/array/uniqBy.mjs

@@ -7,9 +7,9 @@
 *
 * @template T - The type of elements in the array.
 * @template U - The type of mapped elements.
-* @param {T[]} arr - The array to process.
-* @param {(item: T) => U} mapper - The function used to convert the array elements.
-* @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
+* @param arr - The array to process.
+* @param mapper - The function used to convert the array elements.
+* @returns A new array containing only the unique elements from the original array, based on the values returned by the mapper function.
 *
 * @example
 * ```ts

package/dist/array/uniqWith.d.mts

@@ -4,9 +4,9 @@
  * based on the values returned by the comparator function.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to process.
- * @param {(item1: T, item2: T) => boolean} areItemsEqual - The function used to compare the array elements.
- * @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
+ * @param arr - The array to process.
+ * @param areItemsEqual - The function used to compare the array elements.
+ * @returns A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
  *
  * @example
  * ```ts

package/dist/array/uniqWith.d.ts

@@ -4,9 +4,9 @@
  * based on the values returned by the comparator function.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to process.
- * @param {(item1: T, item2: T) => boolean} areItemsEqual - The function used to compare the array elements.
- * @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
+ * @param arr - The array to process.
+ * @param areItemsEqual - The function used to compare the array elements.
+ * @returns A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
  *
  * @example
  * ```ts

package/dist/array/uniqWith.js

@@ -4,9 +4,9 @@
 * based on the values returned by the comparator function.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array to process.
-* @param {(item1: T, item2: T) => boolean} areItemsEqual - The function used to compare the array elements.
-* @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
+* @param arr - The array to process.
+* @param areItemsEqual - The function used to compare the array elements.
+* @returns A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
 *
 * @example
 * ```ts

package/dist/array/uniqWith.mjs

@@ -4,9 +4,9 @@
 * based on the values returned by the comparator function.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array to process.
-* @param {(item1: T, item2: T) => boolean} areItemsEqual - The function used to compare the array elements.
-* @returns {T[]} A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
+* @param arr - The array to process.
+* @param areItemsEqual - The function used to compare the array elements.
+* @returns A new array containing only the unique elements from the original array, based on the values returned by the comparator function.
 *
 * @example
 * ```ts

package/dist/array/unzip.d.mts

@@ -4,8 +4,8 @@
  * from a grouped array of elements and returns them as a new array.
  *
  * @template T - The type of elements in the nested array.
- * @param {Array<[...T]>} zipped - The nested array to unzip.
- * @returns {Unzip<T>} A new array of unzipped elements.
+ * @param zipped - The nested array to unzip.
+ * @returns A new array of unzipped elements.
  *
  * @example
  * const zipped = [['a', true, 1],['b', false, 2]];

package/dist/array/unzip.d.ts

@@ -4,8 +4,8 @@
  * from a grouped array of elements and returns them as a new array.
  *
  * @template T - The type of elements in the nested array.
- * @param {Array<[...T]>} zipped - The nested array to unzip.
- * @returns {Unzip<T>} A new array of unzipped elements.
+ * @param zipped - The nested array to unzip.
+ * @returns A new array of unzipped elements.
  *
  * @example
  * const zipped = [['a', true, 1],['b', false, 2]];

package/dist/array/unzip.js

@@ -4,8 +4,8 @@
 * from a grouped array of elements and returns them as a new array.
 *
 * @template T - The type of elements in the nested array.
-* @param {Array<[...T]>} zipped - The nested array to unzip.
-* @returns {Unzip<T>} A new array of unzipped elements.
+* @param zipped - The nested array to unzip.
+* @returns A new array of unzipped elements.
 *
 * @example
 * const zipped = [['a', true, 1],['b', false, 2]];

package/dist/array/unzip.mjs

@@ -4,8 +4,8 @@
 * from a grouped array of elements and returns them as a new array.
 *
 * @template T - The type of elements in the nested array.
-* @param {Array<[...T]>} zipped - The nested array to unzip.
-* @returns {Unzip<T>} A new array of unzipped elements.
+* @param zipped - The nested array to unzip.
+* @returns A new array of unzipped elements.
 *
 * @example
 * const zipped = [['a', true, 1],['b', false, 2]];

package/dist/array/unzipWith.d.mts

@@ -3,10 +3,10 @@
  * Unzips an array of arrays, applying an `iteratee` function to regrouped elements.
  *
  * @template T, R
- * @param {T[][]} target - The nested array to unzip. This is an array of arrays,
+ * @param target - The nested array to unzip. This is an array of arrays,
  * where each inner array contains elements to be unzipped.
- * @param {(...args: T[]) => R} iteratee - A function to transform the unzipped elements.
- * @returns {R[]} A new array of unzipped and transformed elements.
+ * @param iteratee - A function to transform the unzipped elements.
+ * @returns A new array of unzipped and transformed elements.
  *
  * @example
  * const nestedArray = [[1, 2], [3, 4], [5, 6]];

package/dist/array/unzipWith.d.ts

@@ -3,10 +3,10 @@
  * Unzips an array of arrays, applying an `iteratee` function to regrouped elements.
  *
  * @template T, R
- * @param {T[][]} target - The nested array to unzip. This is an array of arrays,
+ * @param target - The nested array to unzip. This is an array of arrays,
  * where each inner array contains elements to be unzipped.
- * @param {(...args: T[]) => R} iteratee - A function to transform the unzipped elements.
- * @returns {R[]} A new array of unzipped and transformed elements.
+ * @param iteratee - A function to transform the unzipped elements.
+ * @returns A new array of unzipped and transformed elements.
  *
  * @example
  * const nestedArray = [[1, 2], [3, 4], [5, 6]];

package/dist/array/unzipWith.js

@@ -3,10 +3,10 @@
 * Unzips an array of arrays, applying an `iteratee` function to regrouped elements.
 *
 * @template T, R
-* @param {T[][]} target - The nested array to unzip. This is an array of arrays,
+* @param target - The nested array to unzip. This is an array of arrays,
 * where each inner array contains elements to be unzipped.
-* @param {(...args: T[]) => R} iteratee - A function to transform the unzipped elements.
-* @returns {R[]} A new array of unzipped and transformed elements.
+* @param iteratee - A function to transform the unzipped elements.
+* @returns A new array of unzipped and transformed elements.
 *
 * @example
 * const nestedArray = [[1, 2], [3, 4], [5, 6]];

package/dist/array/unzipWith.mjs

@@ -3,10 +3,10 @@
 * Unzips an array of arrays, applying an `iteratee` function to regrouped elements.
 *
 * @template T, R
-* @param {T[][]} target - The nested array to unzip. This is an array of arrays,
+* @param target - The nested array to unzip. This is an array of arrays,
 * where each inner array contains elements to be unzipped.
-* @param {(...args: T[]) => R} iteratee - A function to transform the unzipped elements.
-* @returns {R[]} A new array of unzipped and transformed elements.
+* @param iteratee - A function to transform the unzipped elements.
+* @returns A new array of unzipped and transformed elements.
 *
 * @example
 * const nestedArray = [[1, 2], [3, 4], [5, 6]];

package/dist/array/windowed.d.mts

@@ -26,12 +26,12 @@ interface WindowedOptions {
  * Partial windows are smaller sub-arrays created when there aren't enough elements left in the input array to form a full window.
  *
  * @template T
- * @param {readonly T[]} arr - The input array to create windows from.
- * @param {number} size - The size of each window. Must be a positive integer.
- * @param {number} [step=1] - The step size between the start of each window. Must be a positive integer.
- * @param {WindowedOptions} [options={}] - Options object to configure the behavior of the function.
- * @param {boolean} [options.partialWindows=false] - Whether to include partial windows at the end of the array.
- * @returns {T[][]} An array of windows (sub-arrays) created from the input array.
+ * @param arr - The input array to create windows from.
+ * @param size - The size of each window. Must be a positive integer.
+ * @param [step=1] - The step size between the start of each window. Must be a positive integer.
+ * @param [options={}] - Options object to configure the behavior of the function.
+ * @param [options.partialWindows=false] - Whether to include partial windows at the end of the array.
+ * @returns An array of windows (sub-arrays) created from the input array.
  * @throws {Error} If the size or step is not a positive integer.
  *
  * @example

package/dist/array/windowed.d.ts

@@ -26,12 +26,12 @@ interface WindowedOptions {
  * Partial windows are smaller sub-arrays created when there aren't enough elements left in the input array to form a full window.
  *
  * @template T
- * @param {readonly T[]} arr - The input array to create windows from.
- * @param {number} size - The size of each window. Must be a positive integer.
- * @param {number} [step=1] - The step size between the start of each window. Must be a positive integer.
- * @param {WindowedOptions} [options={}] - Options object to configure the behavior of the function.
- * @param {boolean} [options.partialWindows=false] - Whether to include partial windows at the end of the array.
- * @returns {T[][]} An array of windows (sub-arrays) created from the input array.
+ * @param arr - The input array to create windows from.
+ * @param size - The size of each window. Must be a positive integer.
+ * @param [step=1] - The step size between the start of each window. Must be a positive integer.
+ * @param [options={}] - Options object to configure the behavior of the function.
+ * @param [options.partialWindows=false] - Whether to include partial windows at the end of the array.
+ * @returns An array of windows (sub-arrays) created from the input array.
  * @throws {Error} If the size or step is not a positive integer.
  *
  * @example

package/dist/array/windowed.js

@@ -9,12 +9,12 @@
 * Partial windows are smaller sub-arrays created when there aren't enough elements left in the input array to form a full window.
 *
 * @template T
-* @param {readonly T[]} arr - The input array to create windows from.
-* @param {number} size - The size of each window. Must be a positive integer.
-* @param {number} [step=1] - The step size between the start of each window. Must be a positive integer.
-* @param {WindowedOptions} [options={}] - Options object to configure the behavior of the function.
-* @param {boolean} [options.partialWindows=false] - Whether to include partial windows at the end of the array.
-* @returns {T[][]} An array of windows (sub-arrays) created from the input array.
+* @param arr - The input array to create windows from.
+* @param size - The size of each window. Must be a positive integer.
+* @param [step=1] - The step size between the start of each window. Must be a positive integer.
+* @param [options={}] - Options object to configure the behavior of the function.
+* @param [options.partialWindows=false] - Whether to include partial windows at the end of the array.
+* @returns An array of windows (sub-arrays) created from the input array.
 * @throws {Error} If the size or step is not a positive integer.
 *
 * @example

package/dist/array/windowed.mjs

@@ -9,12 +9,12 @@
 * Partial windows are smaller sub-arrays created when there aren't enough elements left in the input array to form a full window.
 *
 * @template T
-* @param {readonly T[]} arr - The input array to create windows from.
-* @param {number} size - The size of each window. Must be a positive integer.
-* @param {number} [step=1] - The step size between the start of each window. Must be a positive integer.
-* @param {WindowedOptions} [options={}] - Options object to configure the behavior of the function.
-* @param {boolean} [options.partialWindows=false] - Whether to include partial windows at the end of the array.
-* @returns {T[][]} An array of windows (sub-arrays) created from the input array.
+* @param arr - The input array to create windows from.
+* @param size - The size of each window. Must be a positive integer.
+* @param [step=1] - The step size between the start of each window. Must be a positive integer.
+* @param [options={}] - Options object to configure the behavior of the function.
+* @param [options.partialWindows=false] - Whether to include partial windows at the end of the array.
+* @returns An array of windows (sub-arrays) created from the input array.
 * @throws {Error} If the size or step is not a positive integer.
 *
 * @example

package/dist/array/without.d.mts

@@ -5,9 +5,9 @@
  * It correctly excludes `NaN`, as it compares values using [SameValueZero](https://tc39.es/ecma262/multipage/abstract-operations.html#sec-samevaluezero).
  *
  * @template T The type of elements in the array.
- * @param {T[]} array - The array to filter.
- * @param {...T[]} values - The values to exclude.
- * @returns {T[]} A new array without the specified values.
+ * @param array - The array to filter.
+ * @param values - The values to exclude.
+ * @returns A new array without the specified values.
  *
  * @example
  * // Removes the specified values from the array

package/dist/array/without.d.ts

@@ -5,9 +5,9 @@
  * It correctly excludes `NaN`, as it compares values using [SameValueZero](https://tc39.es/ecma262/multipage/abstract-operations.html#sec-samevaluezero).
  *
  * @template T The type of elements in the array.
- * @param {T[]} array - The array to filter.
- * @param {...T[]} values - The values to exclude.
- * @returns {T[]} A new array without the specified values.
+ * @param array - The array to filter.
+ * @param values - The values to exclude.
+ * @returns A new array without the specified values.
  *
  * @example
  * // Removes the specified values from the array

package/dist/array/without.js

@@ -6,9 +6,9 @@ const require_difference = require("./difference.js");
 * It correctly excludes `NaN`, as it compares values using [SameValueZero](https://tc39.es/ecma262/multipage/abstract-operations.html#sec-samevaluezero).
 *
 * @template T The type of elements in the array.
-* @param {T[]} array - The array to filter.
-* @param {...T[]} values - The values to exclude.
-* @returns {T[]} A new array without the specified values.
+* @param array - The array to filter.
+* @param values - The values to exclude.
+* @returns A new array without the specified values.
 *
 * @example
 * // Removes the specified values from the array

package/dist/array/without.mjs

@@ -6,9 +6,9 @@ import { difference } from "./difference.mjs";
 * It correctly excludes `NaN`, as it compares values using [SameValueZero](https://tc39.es/ecma262/multipage/abstract-operations.html#sec-samevaluezero).
 *
 * @template T The type of elements in the array.
-* @param {T[]} array - The array to filter.
-* @param {...T[]} values - The values to exclude.
-* @returns {T[]} A new array without the specified values.
+* @param array - The array to filter.
+* @param values - The values to exclude.
+* @returns A new array without the specified values.
 *
 * @example
 * // Removes the specified values from the array

package/dist/array/xor.d.mts

@@ -4,9 +4,9 @@
  * which are in either of the arrays, but not in their intersection.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr1 - The first array.
- * @param {T[]} arr2 - The second array.
- * @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both.
+ * @param arr1 - The first array.
+ * @param arr2 - The second array.
+ * @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both.
  *
  * @example
  * // Returns [1, 2, 5, 6]

package/dist/array/xor.d.ts

@@ -4,9 +4,9 @@
  * which are in either of the arrays, but not in their intersection.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr1 - The first array.
- * @param {T[]} arr2 - The second array.
- * @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both.
+ * @param arr1 - The first array.
+ * @param arr2 - The second array.
+ * @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both.
  *
  * @example
  * // Returns [1, 2, 5, 6]

package/dist/array/xor.js

@@ -7,9 +7,9 @@ const require_union = require("./union.js");
 * which are in either of the arrays, but not in their intersection.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr1 - The first array.
-* @param {T[]} arr2 - The second array.
-* @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both.
+* @param arr1 - The first array.
+* @param arr2 - The second array.
+* @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both.
 *
 * @example
 * // Returns [1, 2, 5, 6]

package/dist/array/xor.mjs

@@ -7,9 +7,9 @@ import { union } from "./union.mjs";
 * which are in either of the arrays, but not in their intersection.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr1 - The first array.
-* @param {T[]} arr2 - The second array.
-* @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both.
+* @param arr1 - The first array.
+* @param arr2 - The second array.
+* @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both.
 *
 * @example
 * // Returns [1, 2, 5, 6]

package/dist/array/xorBy.d.mts

@@ -7,10 +7,10 @@
  * @template T - Type of elements in the input arrays.
  * @template U - Type of the values returned by the mapping function.
  *
- * @param {T[]} arr1 - The first array.
- * @param {T[]} arr2 - The second array.
- * @param {(item: T) => U} mapper - The function to map array elements to comparison values.
- * @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
+ * @param arr1 - The first array.
+ * @param arr2 - The second array.
+ * @param mapper - The function to map array elements to comparison values.
+ * @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
  *
  * @example
  * // Custom mapping function for objects with an 'id' property

package/dist/array/xorBy.d.ts

@@ -7,10 +7,10 @@
  * @template T - Type of elements in the input arrays.
  * @template U - Type of the values returned by the mapping function.
  *
- * @param {T[]} arr1 - The first array.
- * @param {T[]} arr2 - The second array.
- * @param {(item: T) => U} mapper - The function to map array elements to comparison values.
- * @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
+ * @param arr1 - The first array.
+ * @param arr2 - The second array.
+ * @param mapper - The function to map array elements to comparison values.
+ * @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
  *
  * @example
  * // Custom mapping function for objects with an 'id' property

package/dist/array/xorBy.js

@@ -10,10 +10,10 @@ const require_unionBy = require("./unionBy.js");
 * @template T - Type of elements in the input arrays.
 * @template U - Type of the values returned by the mapping function.
 *
-* @param {T[]} arr1 - The first array.
-* @param {T[]} arr2 - The second array.
-* @param {(item: T) => U} mapper - The function to map array elements to comparison values.
-* @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
+* @param arr1 - The first array.
+* @param arr2 - The second array.
+* @param mapper - The function to map array elements to comparison values.
+* @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
 *
 * @example
 * // Custom mapping function for objects with an 'id' property

package/dist/array/xorBy.mjs

@@ -10,10 +10,10 @@ import { unionBy } from "./unionBy.mjs";
 * @template T - Type of elements in the input arrays.
 * @template U - Type of the values returned by the mapping function.
 *
-* @param {T[]} arr1 - The first array.
-* @param {T[]} arr2 - The second array.
-* @param {(item: T) => U} mapper - The function to map array elements to comparison values.
-* @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
+* @param arr1 - The first array.
+* @param arr2 - The second array.
+* @param mapper - The function to map array elements to comparison values.
+* @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the values returned by the mapping function.
 *
 * @example
 * // Custom mapping function for objects with an 'id' property

package/dist/array/xorWith.d.mts

@@ -6,10 +6,10 @@
  *
  * @template T - Type of elements in the input arrays.
  *
- * @param {T[]} arr1 - The first array.
- * @param {T[]} arr2 - The second array.
- * @param {(item1: T, item2: T) => boolean} areElementsEqual - The custom equality function to compare elements.
- * @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
+ * @param arr1 - The first array.
+ * @param arr2 - The second array.
+ * @param areElementsEqual - The custom equality function to compare elements.
+ * @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
  *
  * @example
  * // Custom equality function for objects with an 'id' property

package/dist/array/xorWith.d.ts

@@ -6,10 +6,10 @@
  *
  * @template T - Type of elements in the input arrays.
  *
- * @param {T[]} arr1 - The first array.
- * @param {T[]} arr2 - The second array.
- * @param {(item1: T, item2: T) => boolean} areElementsEqual - The custom equality function to compare elements.
- * @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
+ * @param arr1 - The first array.
+ * @param arr2 - The second array.
+ * @param areElementsEqual - The custom equality function to compare elements.
+ * @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
  *
  * @example
  * // Custom equality function for objects with an 'id' property

package/dist/array/xorWith.js

@@ -9,10 +9,10 @@ const require_unionWith = require("./unionWith.js");
 *
 * @template T - Type of elements in the input arrays.
 *
-* @param {T[]} arr1 - The first array.
-* @param {T[]} arr2 - The second array.
-* @param {(item1: T, item2: T) => boolean} areElementsEqual - The custom equality function to compare elements.
-* @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
+* @param arr1 - The first array.
+* @param arr2 - The second array.
+* @param areElementsEqual - The custom equality function to compare elements.
+* @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
 *
 * @example
 * // Custom equality function for objects with an 'id' property

package/dist/array/xorWith.mjs

@@ -9,10 +9,10 @@ import { unionWith } from "./unionWith.mjs";
 *
 * @template T - Type of elements in the input arrays.
 *
-* @param {T[]} arr1 - The first array.
-* @param {T[]} arr2 - The second array.
-* @param {(item1: T, item2: T) => boolean} areElementsEqual - The custom equality function to compare elements.
-* @returns {T[]} An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
+* @param arr1 - The first array.
+* @param arr2 - The second array.
+* @param areElementsEqual - The custom equality function to compare elements.
+* @returns An array containing the elements that are present in either `arr1` or `arr2` but not in both, based on the custom equality function.
 *
 * @example
 * // Custom equality function for objects with an 'id' property

package/dist/array/zip.d.mts

@@ -8,8 +8,8 @@
  * with undefined values for missing elements.
  *
  * @template T
- * @param {T[]} arr1 - The first array to zip.
- * @returns {Array<[T]>} A new array of tuples containing the corresponding elements from the input arrays.
+ * @param arr1 - The first array to zip.
+ * @returns A new array of tuples containing the corresponding elements from the input arrays.
  *
  * @example
  * const arr1 = [1, 2, 3];
@@ -26,9 +26,9 @@ declare function zip<T>(arr1: readonly T[]): Array<[T]>;
  * with undefined values for missing elements.
  *
  * @template T, U
- * @param {T[]} arr1 - The first array to zip.
- * @param {U[]} arr2 - The second array to zip.
- * @returns {Array<[T, U]>} A new array of tuples containing the corresponding elements from the input arrays.
+ * @param arr1 - The first array to zip.
+ * @param arr2 - The second array to zip.
+ * @returns A new array of tuples containing the corresponding elements from the input arrays.
  *
  * @example
  * const arr1 = [1, 2, 3];
@@ -46,10 +46,10 @@ declare function zip<T, U>(arr1: readonly T[], arr2: readonly U[]): Array<[T, U]
  * with undefined values for missing elements.
  *
  * @template T, U, V
- * @param {T[]} arr1 - The first array to zip.
- * @param {U[]} arr2 - The second array to zip.
- * @param {V[]} arr3 - The third array to zip.
- * @returns {Array<[T, U, V]>} A new array of tuples containing the corresponding elements from the input arrays.
+ * @param arr1 - The first array to zip.
+ * @param arr2 - The second array to zip.
+ * @param arr3 - The third array to zip.
+ * @returns A new array of tuples containing the corresponding elements from the input arrays.
  *
  * @example
  * const arr1 = [1, 2, 3];
@@ -68,11 +68,11 @@ declare function zip<T, U, V>(arr1: readonly T[], arr2: readonly U[], arr3: read
  * with undefined values for missing elements.
  *
  * @template T, U, V, W
- * @param {T[]} arr1 - The first array to zip.
- * @param {U[]} arr2 - The second array to zip.
- * @param {V[]} arr3 - The third array to zip.
- * @param {W[]} arr4 - The fourth array to zip.
- * @returns {Array<[T, U, V, W]>} A new array of tuples containing the corresponding elements from the input arrays.
+ * @param arr1 - The first array to zip.
+ * @param arr2 - The second array to zip.
+ * @param arr3 - The third array to zip.
+ * @param arr4 - The fourth array to zip.
+ * @returns A new array of tuples containing the corresponding elements from the input arrays.
  *
  * @example
  * const arr1 = [1, 2, 3];
@@ -92,8 +92,8 @@ declare function zip<T, U, V, W>(arr1: readonly T[], arr2: readonly U[], arr3: r
  * with undefined values for missing elements.
  *
  * @template T
- * @param {...Array<readonly T[]>} arrs - The arrays to zip together.
- * @returns {T[][]} A new array of tuples containing the corresponding elements from the input arrays.
+ * @param arrs - The arrays to zip together.
+ * @returns A new array of tuples containing the corresponding elements from the input arrays.
  *
  * @example
  * const arr1 = [1, 2, 3];