23 lines
725 B
TypeScript
23 lines
725 B
TypeScript
import { ListOfRecursiveArraysOrValues } from "../_internal/ListOfRecursiveArraysOrValues.mjs";
|
|
|
|
//#region src/compat/array/flattenDepth.d.ts
|
|
/**
|
|
* Recursively flattens array up to depth times.
|
|
*
|
|
* @template T
|
|
* @param {ArrayLike<T> | null | undefined} array - The array to flatten.
|
|
* @param {number} [depth=1] - The maximum recursion depth.
|
|
* @returns {T[]} Returns the new flattened array.
|
|
*
|
|
* @example
|
|
* const array = [1, [2, [3, [4]], 5]];
|
|
*
|
|
* flattenDepth(array, 1);
|
|
* // => [1, 2, [3, [4]], 5]
|
|
*
|
|
* flattenDepth(array, 2);
|
|
* // => [1, 2, 3, [4], 5]
|
|
*/
|
|
declare function flattenDepth<T>(array: ListOfRecursiveArraysOrValues<T> | null | undefined, depth?: number): T[];
|
|
//#endregion
|
|
export { flattenDepth }; |