flattenDepth

INFO

出于兼容性原因，此函数仅在 es-toolkit/compat 中提供。它可能具有替代的原生 JavaScript API，或者尚未完全优化。

从 es-toolkit/compat 导入时，它的行为与 lodash 完全一致，并提供相同的功能，详情请见 这里。

将数组展平到指定的深度。

签名

function flattenDepth<T, D extends number = 1>(value: T[], depth: D): Array<FlatArray<T[], D>> | [];

参数

• value (T[]): 要展平的值。

value 可以是 ArrayLike<T>、null 或 undefined。

为了确保与 lodash 的完全兼容性，flattenDepth 函数以以下方式处理 value：

• 如果 value 是 ArrayLike<T>，则会使用 Array.from(...) 将其转换为数组。
• 如果 value 是 null 或 undefined，则会将其视为一个空数组。

• depth (D): 指定嵌套数组结构展平深度的级别。默认值为1。

返回值

(Array<FlatArray<T[], D>> | []): 展平后的新数组。

示例

const arr = flattenDepth([1, [2, 3], [4, [5, 6]]], 1);
// Returns: [1, 2, 3, 4, [5, 6]]

const arr = flattenDepth([1, [2, 3], [4, [5, 6]]], 2);
// Returns: [1, 2, 3, 4, 5, 6]