es-toolkit 1.47.0 → 1.47.1-dev.1853

package/dist/array/dropRightWhile.d.ts

@@ -6,11 +6,11 @@
  * predicate function returns false. It then returns a new array with the remaining elements.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array from which to drop elements.
- * @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
+ * @param arr - The array from which to drop elements.
+ * @param canContinueDropping - A predicate function that determines
  * whether to continue dropping elements. The function is called with each element from the end,
  * and dropping continues as long as it returns true.
- * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ * @returns A new array with the elements remaining after the predicate returns false.
  *
  * @example
  * const array = [1, 2, 3, 4, 5];

package/dist/array/dropRightWhile.js

@@ -6,11 +6,11 @@
 * predicate function returns false. It then returns a new array with the remaining elements.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array from which to drop elements.
-* @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
+* @param arr - The array from which to drop elements.
+* @param canContinueDropping - A predicate function that determines
 * whether to continue dropping elements. The function is called with each element from the end,
 * and dropping continues as long as it returns true.
-* @returns {T[]} A new array with the elements remaining after the predicate returns false.
+* @returns A new array with the elements remaining after the predicate returns false.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/dropRightWhile.mjs

@@ -6,11 +6,11 @@
 * predicate function returns false. It then returns a new array with the remaining elements.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array from which to drop elements.
-* @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
+* @param arr - The array from which to drop elements.
+* @param canContinueDropping - A predicate function that determines
 * whether to continue dropping elements. The function is called with each element from the end,
 * and dropping continues as long as it returns true.
-* @returns {T[]} A new array with the elements remaining after the predicate returns false.
+* @returns A new array with the elements remaining after the predicate returns false.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/dropWhile.d.mts

@@ -6,11 +6,11 @@
  * predicate function returns false. It then returns a new array with the remaining elements.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array from which to drop elements.
- * @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
+ * @param arr - The array from which to drop elements.
+ * @param canContinueDropping - A predicate function that determines
  * whether to continue dropping elements. The function is called with each element, and dropping
  * continues as long as it returns true.
- * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ * @returns A new array with the elements remaining after the predicate returns false.
  *
  * @example
  * const array = [1, 2, 3, 4, 5];

package/dist/array/dropWhile.d.ts

@@ -6,11 +6,11 @@
  * predicate function returns false. It then returns a new array with the remaining elements.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array from which to drop elements.
- * @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
+ * @param arr - The array from which to drop elements.
+ * @param canContinueDropping - A predicate function that determines
  * whether to continue dropping elements. The function is called with each element, and dropping
  * continues as long as it returns true.
- * @returns {T[]} A new array with the elements remaining after the predicate returns false.
+ * @returns A new array with the elements remaining after the predicate returns false.
  *
  * @example
  * const array = [1, 2, 3, 4, 5];

package/dist/array/dropWhile.js

@@ -6,11 +6,11 @@
 * predicate function returns false. It then returns a new array with the remaining elements.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array from which to drop elements.
-* @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
+* @param arr - The array from which to drop elements.
+* @param canContinueDropping - A predicate function that determines
 * whether to continue dropping elements. The function is called with each element, and dropping
 * continues as long as it returns true.
-* @returns {T[]} A new array with the elements remaining after the predicate returns false.
+* @returns A new array with the elements remaining after the predicate returns false.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/dropWhile.mjs

@@ -6,11 +6,11 @@
 * predicate function returns false. It then returns a new array with the remaining elements.
 *
 * @template T - The type of elements in the array.
-* @param {T[]} arr - The array from which to drop elements.
-* @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
+* @param arr - The array from which to drop elements.
+* @param canContinueDropping - A predicate function that determines
 * whether to continue dropping elements. The function is called with each element, and dropping
 * continues as long as it returns true.
-* @returns {T[]} A new array with the elements remaining after the predicate returns false.
+* @returns A new array with the elements remaining after the predicate returns false.
 *
 * @example
 * const array = [1, 2, 3, 4, 5];

package/dist/array/fill.d.mts

@@ -7,9 +7,9 @@
  * entire array.
  *
  * @template T - The type of the value to fill the array with.
- * @param {unknown[]} array - The array to fill.
- * @param {T} value - The value to fill the array with.
- * @returns {T[]} The array with the filled values.
+ * @param array - The array to fill.
+ * @param value - The value to fill the array with.
+ * @returns The array with the filled values.
  *
  * @example
  * fill([1, 2, 3], 'a');
@@ -34,10 +34,10 @@ declare function fill<T>(array: unknown[], value: T): T[];
  *
  * @template T - The type of elements in the original array.
  * @template U - The type of the value to fill the array with.
- * @param {Array<T | U>} array - The array to fill.
- * @param {U} value - The value to fill the array with.
- * @param {number} [start=0] - The start position. Defaults to 0.
- * @returns {Array<T | U>} The array with the filled values.
+ * @param array - The array to fill.
+ * @param value - The value to fill the array with.
+ * @param [start=0] - The start position. Defaults to 0.
+ * @returns The array with the filled values.
  *
  * @example
  * fill([1, 2, 3], 'a');
@@ -62,11 +62,11 @@ declare function fill<T, U>(array: Array<T | U>, value: U, start: number): Array
  *
  * @template T - The type of elements in the original array.
  * @template U - The type of the value to fill the array with.
- * @param {Array<T | U>} array - The array to fill.
- * @param {U} value - The value to fill the array with.
- * @param {number} [start=0] - The start position. Defaults to 0.
- * @param {number} [end=arr.length] - The end position. Defaults to the array's length.
- * @returns {Array<T | U>} The array with the filled values.
+ * @param array - The array to fill.
+ * @param value - The value to fill the array with.
+ * @param [start=0] - The start position. Defaults to 0.
+ * @param [end=arr.length] - The end position. Defaults to the array's length.
+ * @returns The array with the filled values.
  *
  * @example
  * fill([1, 2, 3], 'a');

package/dist/array/fill.d.ts

@@ -7,9 +7,9 @@
  * entire array.
  *
  * @template T - The type of the value to fill the array with.
- * @param {unknown[]} array - The array to fill.
- * @param {T} value - The value to fill the array with.
- * @returns {T[]} The array with the filled values.
+ * @param array - The array to fill.
+ * @param value - The value to fill the array with.
+ * @returns The array with the filled values.
  *
  * @example
  * fill([1, 2, 3], 'a');
@@ -34,10 +34,10 @@ declare function fill<T>(array: unknown[], value: T): T[];
  *
  * @template T - The type of elements in the original array.
  * @template U - The type of the value to fill the array with.
- * @param {Array<T | U>} array - The array to fill.
- * @param {U} value - The value to fill the array with.
- * @param {number} [start=0] - The start position. Defaults to 0.
- * @returns {Array<T | U>} The array with the filled values.
+ * @param array - The array to fill.
+ * @param value - The value to fill the array with.
+ * @param [start=0] - The start position. Defaults to 0.
+ * @returns The array with the filled values.
  *
  * @example
  * fill([1, 2, 3], 'a');
@@ -62,11 +62,11 @@ declare function fill<T, U>(array: Array<T | U>, value: U, start: number): Array
  *
  * @template T - The type of elements in the original array.
  * @template U - The type of the value to fill the array with.
- * @param {Array<T | U>} array - The array to fill.
- * @param {U} value - The value to fill the array with.
- * @param {number} [start=0] - The start position. Defaults to 0.
- * @param {number} [end=arr.length] - The end position. Defaults to the array's length.
- * @returns {Array<T | U>} The array with the filled values.
+ * @param array - The array to fill.
+ * @param value - The value to fill the array with.
+ * @param [start=0] - The start position. Defaults to 0.
+ * @param [end=arr.length] - The end position. Defaults to the array's length.
+ * @returns The array with the filled values.
  *
  * @example
  * fill([1, 2, 3], 'a');

package/dist/array/fill.js

@@ -8,11 +8,11 @@
 *
 * @template T - The type of elements in the original array.
 * @template U - The type of the value to fill the array with.
-* @param {Array<T | U>} array - The array to fill.
-* @param {U} value - The value to fill the array with.
-* @param {number} [start=0] - The start position. Defaults to 0.
-* @param {number} [end=arr.length] - The end position. Defaults to the array's length.
-* @returns {Array<T | U>} The array with the filled values.
+* @param array - The array to fill.
+* @param value - The value to fill the array with.
+* @param [start=0] - The start position. Defaults to 0.
+* @param [end=arr.length] - The end position. Defaults to the array's length.
+* @returns The array with the filled values.
 *
 * @example
 * fill([1, 2, 3], 'a');

package/dist/array/fill.mjs

@@ -8,11 +8,11 @@
 *
 * @template T - The type of elements in the original array.
 * @template U - The type of the value to fill the array with.
-* @param {Array<T | U>} array - The array to fill.
-* @param {U} value - The value to fill the array with.
-* @param {number} [start=0] - The start position. Defaults to 0.
-* @param {number} [end=arr.length] - The end position. Defaults to the array's length.
-* @returns {Array<T | U>} The array with the filled values.
+* @param array - The array to fill.
+* @param value - The value to fill the array with.
+* @param [start=0] - The start position. Defaults to 0.
+* @param [end=arr.length] - The end position. Defaults to the array's length.
+* @returns The array with the filled values.
 *
 * @example
 * fill([1, 2, 3], 'a');

package/dist/array/filterAsync.d.mts

@@ -9,11 +9,11 @@ interface FilterAsyncOptions {
  * for which the predicate function returns a truthy value.
  *
  * @template T - The type of elements in the array.
- * @param {readonly T[]} array The array to filter.
- * @param {(item: T, index: number, array: readonly T[]) => Promise<boolean>} predicate An async function that tests each element.
- * @param {FilterAsyncOptions} [options] Optional configuration object.
- * @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
- * @returns {Promise<T[]>} A promise that resolves to the filtered array.
+ * @param array The array to filter.
+ * @param predicate An async function that tests each element.
+ * @param [options] Optional configuration object.
+ * @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+ * @returns A promise that resolves to the filtered array.
  * @example
  * const users = [{ id: 1, active: true }, { id: 2, active: false }, { id: 3, active: true }];
  * const activeUsers = await filterAsync(users, async (user) => {

package/dist/array/filterAsync.d.ts

@@ -9,11 +9,11 @@ interface FilterAsyncOptions {
  * for which the predicate function returns a truthy value.
  *
  * @template T - The type of elements in the array.
- * @param {readonly T[]} array The array to filter.
- * @param {(item: T, index: number, array: readonly T[]) => Promise<boolean>} predicate An async function that tests each element.
- * @param {FilterAsyncOptions} [options] Optional configuration object.
- * @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
- * @returns {Promise<T[]>} A promise that resolves to the filtered array.
+ * @param array The array to filter.
+ * @param predicate An async function that tests each element.
+ * @param [options] Optional configuration object.
+ * @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+ * @returns A promise that resolves to the filtered array.
  * @example
  * const users = [{ id: 1, active: true }, { id: 2, active: false }, { id: 3, active: true }];
  * const activeUsers = await filterAsync(users, async (user) => {

package/dist/array/filterAsync.js

@@ -7,11 +7,11 @@ const require_limitAsync = require("./limitAsync.js");
 * for which the predicate function returns a truthy value.
 *
 * @template T - The type of elements in the array.
-* @param {readonly T[]} array The array to filter.
-* @param {(item: T, index: number, array: readonly T[]) => Promise<boolean>} predicate An async function that tests each element.
-* @param {FilterAsyncOptions} [options] Optional configuration object.
-* @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
-* @returns {Promise<T[]>} A promise that resolves to the filtered array.
+* @param array The array to filter.
+* @param predicate An async function that tests each element.
+* @param [options] Optional configuration object.
+* @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+* @returns A promise that resolves to the filtered array.
 * @example
 * const users = [{ id: 1, active: true }, { id: 2, active: false }, { id: 3, active: true }];
 * const activeUsers = await filterAsync(users, async (user) => {

package/dist/array/filterAsync.mjs

@@ -7,11 +7,11 @@ import { limitAsync } from "./limitAsync.mjs";
 * for which the predicate function returns a truthy value.
 *
 * @template T - The type of elements in the array.
-* @param {readonly T[]} array The array to filter.
-* @param {(item: T, index: number, array: readonly T[]) => Promise<boolean>} predicate An async function that tests each element.
-* @param {FilterAsyncOptions} [options] Optional configuration object.
-* @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
-* @returns {Promise<T[]>} A promise that resolves to the filtered array.
+* @param array The array to filter.
+* @param predicate An async function that tests each element.
+* @param [options] Optional configuration object.
+* @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+* @returns A promise that resolves to the filtered array.
 * @example
 * const users = [{ id: 1, active: true }, { id: 2, active: false }, { id: 3, active: true }];
 * const activeUsers = await filterAsync(users, async (user) => {

package/dist/array/flatMap.d.mts

@@ -5,10 +5,10 @@
  * @template T - The type of elements within the array.
  * @template U - The type of elements within the returned array from the iteratee function.
  * @template D - The depth to which the array should be flattened.
- * @param {T[]} arr - The array to flatten.
- * @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
- * @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
- * @returns {Array<FlatArray<U[], D>>} The new array with the mapped and flattened elements.
+ * @param arr - The array to flatten.
+ * @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+ * @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+ * @returns The new array with the mapped and flattened elements.
  *
  * @example
  * const arr = [1, 2, 3];

package/dist/array/flatMap.d.ts

@@ -5,10 +5,10 @@
  * @template T - The type of elements within the array.
  * @template U - The type of elements within the returned array from the iteratee function.
  * @template D - The depth to which the array should be flattened.
- * @param {T[]} arr - The array to flatten.
- * @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
- * @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
- * @returns {Array<FlatArray<U[], D>>} The new array with the mapped and flattened elements.
+ * @param arr - The array to flatten.
+ * @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+ * @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+ * @returns The new array with the mapped and flattened elements.
  *
  * @example
  * const arr = [1, 2, 3];

package/dist/array/flatMap.js

@@ -6,10 +6,10 @@ const require_flatten = require("./flatten.js");
 * @template T - The type of elements within the array.
 * @template U - The type of elements within the returned array from the iteratee function.
 * @template D - The depth to which the array should be flattened.
-* @param {T[]} arr - The array to flatten.
-* @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
-* @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
-* @returns {Array<FlatArray<U[], D>>} The new array with the mapped and flattened elements.
+* @param arr - The array to flatten.
+* @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+* @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+* @returns The new array with the mapped and flattened elements.
 *
 * @example
 * const arr = [1, 2, 3];

package/dist/array/flatMap.mjs

@@ -6,10 +6,10 @@ import { flatten } from "./flatten.mjs";
 * @template T - The type of elements within the array.
 * @template U - The type of elements within the returned array from the iteratee function.
 * @template D - The depth to which the array should be flattened.
-* @param {T[]} arr - The array to flatten.
-* @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
-* @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
-* @returns {Array<FlatArray<U[], D>>} The new array with the mapped and flattened elements.
+* @param arr - The array to flatten.
+* @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+* @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+* @returns The new array with the mapped and flattened elements.
 *
 * @example
 * const arr = [1, 2, 3];

package/dist/array/flatMapAsync.d.mts

@@ -11,11 +11,11 @@ interface FlatMapAsyncOptions {
  *
  * @template T - The type of elements in the input array.
  * @template R - The type of elements in the arrays returned by the callback.
- * @param {readonly T[]} array The array to transform.
- * @param {(item: T, index: number, array: readonly T[]) => Promise<R[]>} callback An async function that transforms each element into an array.
- * @param {FlatMapAsyncOptions} [options] Optional configuration object.
- * @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
- * @returns {Promise<R[]>} A promise that resolves to a flattened array of transformed values.
+ * @param array The array to transform.
+ * @param callback An async function that transforms each element into an array.
+ * @param [options] Optional configuration object.
+ * @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+ * @returns A promise that resolves to a flattened array of transformed values.
  * @example
  * const users = [{ id: 1 }, { id: 2 }];
  * const allPosts = await flatMapAsync(users, async (user) => {

package/dist/array/flatMapAsync.d.ts

@@ -11,11 +11,11 @@ interface FlatMapAsyncOptions {
  *
  * @template T - The type of elements in the input array.
  * @template R - The type of elements in the arrays returned by the callback.
- * @param {readonly T[]} array The array to transform.
- * @param {(item: T, index: number, array: readonly T[]) => Promise<R[]>} callback An async function that transforms each element into an array.
- * @param {FlatMapAsyncOptions} [options] Optional configuration object.
- * @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
- * @returns {Promise<R[]>} A promise that resolves to a flattened array of transformed values.
+ * @param array The array to transform.
+ * @param callback An async function that transforms each element into an array.
+ * @param [options] Optional configuration object.
+ * @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+ * @returns A promise that resolves to a flattened array of transformed values.
  * @example
  * const users = [{ id: 1 }, { id: 2 }];
  * const allPosts = await flatMapAsync(users, async (user) => {

package/dist/array/flatMapAsync.js

@@ -10,11 +10,11 @@ const require_flatten = require("./flatten.js");
 *
 * @template T - The type of elements in the input array.
 * @template R - The type of elements in the arrays returned by the callback.
-* @param {readonly T[]} array The array to transform.
-* @param {(item: T, index: number, array: readonly T[]) => Promise<R[]>} callback An async function that transforms each element into an array.
-* @param {FlatMapAsyncOptions} [options] Optional configuration object.
-* @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
-* @returns {Promise<R[]>} A promise that resolves to a flattened array of transformed values.
+* @param array The array to transform.
+* @param callback An async function that transforms each element into an array.
+* @param [options] Optional configuration object.
+* @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+* @returns A promise that resolves to a flattened array of transformed values.
 * @example
 * const users = [{ id: 1 }, { id: 2 }];
 * const allPosts = await flatMapAsync(users, async (user) => {

package/dist/array/flatMapAsync.mjs

@@ -10,11 +10,11 @@ import { flatten } from "./flatten.mjs";
 *
 * @template T - The type of elements in the input array.
 * @template R - The type of elements in the arrays returned by the callback.
-* @param {readonly T[]} array The array to transform.
-* @param {(item: T, index: number, array: readonly T[]) => Promise<R[]>} callback An async function that transforms each element into an array.
-* @param {FlatMapAsyncOptions} [options] Optional configuration object.
-* @param {number} [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
-* @returns {Promise<R[]>} A promise that resolves to a flattened array of transformed values.
+* @param array The array to transform.
+* @param callback An async function that transforms each element into an array.
+* @param [options] Optional configuration object.
+* @param [options.concurrency] Maximum number of concurrent async operations. If not specified, all operations run concurrently.
+* @returns A promise that resolves to a flattened array of transformed values.
 * @example
 * const users = [{ id: 1 }, { id: 2 }];
 * const allPosts = await flatMapAsync(users, async (user) => {

package/dist/array/flatMapDeep.d.mts

@@ -6,9 +6,9 @@ import { ExtractNestedArrayType } from "./flattenDeep.mjs";
  *
  * @template T - The type of elements within the array.
  * @template U - The type of elements within the returned array from the iteratee function.
- * @param {T[]} arr - The array to flatten.
- * @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
- * @returns {Array<ExtractNestedArrayType<U>>} A new array that has been flattened.
+ * @param arr - The array to flatten.
+ * @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+ * @returns A new array that has been flattened.
  *
  * @example
  * const result = flatMapDeep([1, 2, 3], n => [[n, n]]);

package/dist/array/flatMapDeep.d.ts

@@ -6,9 +6,9 @@ import { ExtractNestedArrayType } from "./flattenDeep.js";
  *
  * @template T - The type of elements within the array.
  * @template U - The type of elements within the returned array from the iteratee function.
- * @param {T[]} arr - The array to flatten.
- * @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
- * @returns {Array<ExtractNestedArrayType<U>>} A new array that has been flattened.
+ * @param arr - The array to flatten.
+ * @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+ * @returns A new array that has been flattened.
  *
  * @example
  * const result = flatMapDeep([1, 2, 3], n => [[n, n]]);

package/dist/array/flatMapDeep.js

@@ -5,9 +5,9 @@ const require_flattenDeep = require("./flattenDeep.js");
 *
 * @template T - The type of elements within the array.
 * @template U - The type of elements within the returned array from the iteratee function.
-* @param {T[]} arr - The array to flatten.
-* @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
-* @returns {Array<ExtractNestedArrayType<U>>} A new array that has been flattened.
+* @param arr - The array to flatten.
+* @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+* @returns A new array that has been flattened.
 *
 * @example
 * const result = flatMapDeep([1, 2, 3], n => [[n, n]]);

package/dist/array/flatMapDeep.mjs

@@ -5,9 +5,9 @@ import { flattenDeep } from "./flattenDeep.mjs";
 *
 * @template T - The type of elements within the array.
 * @template U - The type of elements within the returned array from the iteratee function.
-* @param {T[]} arr - The array to flatten.
-* @param {(item: T, index: number, array: readonly T[]) => U} iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
-* @returns {Array<ExtractNestedArrayType<U>>} A new array that has been flattened.
+* @param arr - The array to flatten.
+* @param iteratee - The function that produces the new array elements. It receives the element, its index, and the array.
+* @returns A new array that has been flattened.
 *
 * @example
 * const result = flatMapDeep([1, 2, 3], n => [[n, n]]);

package/dist/array/flatten.d.mts

@@ -4,9 +4,9 @@
  *
  * @template T - The type of elements within the array.
  * @template D - The depth to which the array should be flattened.
- * @param {T[]} arr - The array to flatten.
- * @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
- * @returns {Array<FlatArray<T[], D>>} A new array that has been flattened.
+ * @param arr - The array to flatten.
+ * @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+ * @returns A new array that has been flattened.
  *
  * @example
  * const arr = flatten([1, [2, 3], [4, [5, 6]]], 1);

package/dist/array/flatten.d.ts

@@ -4,9 +4,9 @@
  *
  * @template T - The type of elements within the array.
  * @template D - The depth to which the array should be flattened.
- * @param {T[]} arr - The array to flatten.
- * @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
- * @returns {Array<FlatArray<T[], D>>} A new array that has been flattened.
+ * @param arr - The array to flatten.
+ * @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+ * @returns A new array that has been flattened.
  *
  * @example
  * const arr = flatten([1, [2, 3], [4, [5, 6]]], 1);

package/dist/array/flatten.js

@@ -4,9 +4,9 @@
 *
 * @template T - The type of elements within the array.
 * @template D - The depth to which the array should be flattened.
-* @param {T[]} arr - The array to flatten.
-* @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
-* @returns {Array<FlatArray<T[], D>>} A new array that has been flattened.
+* @param arr - The array to flatten.
+* @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+* @returns A new array that has been flattened.
 *
 * @example
 * const arr = flatten([1, [2, 3], [4, [5, 6]]], 1);

package/dist/array/flatten.mjs

@@ -4,9 +4,9 @@
 *
 * @template T - The type of elements within the array.
 * @template D - The depth to which the array should be flattened.
-* @param {T[]} arr - The array to flatten.
-* @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
-* @returns {Array<FlatArray<T[], D>>} A new array that has been flattened.
+* @param arr - The array to flatten.
+* @param depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+* @returns A new array that has been flattened.
 *
 * @example
 * const arr = flatten([1, [2, 3], [4, [5, 6]]], 1);

package/dist/array/flattenDeep.d.mts

@@ -14,8 +14,8 @@ type ExtractNestedArrayType<T> = T extends ReadonlyArray<infer U> ? ExtractNeste
  * Flattens all depths of a nested array.
  *
  * @template T - The type of elements within the array.
- * @param {T[]} arr - The array to flatten.
- * @returns {Array<ExtractNestedArrayType<T>>} A new array that has been flattened.
+ * @param arr - The array to flatten.
+ * @returns A new array that has been flattened.
  *
  * @example
  * const arr = flattenDeep([1, [2, [3]], [4, [5, 6]]]);

package/dist/array/flattenDeep.d.ts

@@ -14,8 +14,8 @@ type ExtractNestedArrayType<T> = T extends ReadonlyArray<infer U> ? ExtractNeste
  * Flattens all depths of a nested array.
  *
  * @template T - The type of elements within the array.
- * @param {T[]} arr - The array to flatten.
- * @returns {Array<ExtractNestedArrayType<T>>} A new array that has been flattened.
+ * @param arr - The array to flatten.
+ * @returns A new array that has been flattened.
  *
  * @example
  * const arr = flattenDeep([1, [2, [3]], [4, [5, 6]]]);

package/dist/array/flattenDeep.js

@@ -4,8 +4,8 @@ const require_flatten = require("./flatten.js");
 * Flattens all depths of a nested array.
 *
 * @template T - The type of elements within the array.
-* @param {T[]} arr - The array to flatten.
-* @returns {Array<ExtractNestedArrayType<T>>} A new array that has been flattened.
+* @param arr - The array to flatten.
+* @returns A new array that has been flattened.
 *
 * @example
 * const arr = flattenDeep([1, [2, [3]], [4, [5, 6]]]);

package/dist/array/flattenDeep.mjs

@@ -4,8 +4,8 @@ import { flatten } from "./flatten.mjs";
 * Flattens all depths of a nested array.
 *
 * @template T - The type of elements within the array.
-* @param {T[]} arr - The array to flatten.
-* @returns {Array<ExtractNestedArrayType<T>>} A new array that has been flattened.
+* @param arr - The array to flatten.
+* @returns A new array that has been flattened.
 *
 * @example
 * const arr = flattenDeep([1, [2, [3]], [4, [5, 6]]]);