Skip to content

dependabit / utils/src / flatten

Function: flatten()

ts
function flatten<T>(arr, depth?): T[];

Defined in: packages/utils/src/array.ts:58

Flattens a nested array up to the given depth.

Type Parameters

Type Parameter
T

Parameters

ParameterTypeDefault valueDescription
arr(T | T[])[]undefinedThe array to flatten.
depthnumber1Depth to flatten.

Returns

T[]

Flattened array.

Default Value

depth = 1

Example

ts
flatten([[1, 2], [3, [4, 5]]], 1); // [1, 2, 3, [4, 5]]

Released under the MIT License.