ArrayFlatten

Flattens nested arrays to the specified depth.

When depth is omitted, the array is flattened completely.

 nested = [ 1, [ 2, [ 3 ] ] ];
 nested.flatten(); // [ 1, 2, 3 ]
 nested.flatten( 1 ); // [ 1, 2, [ 3 ] ]

Method Signature

ArrayFlatten(array=[array], depth=[integer])

Argument

Type

Required

Description

Default

array

true

The array to flatten.

depth

integer

false

The depth to flatten. If omitted, flatten all nested arrays.

When no depth is specified, all levels of nesting are flattened.

nested = [ 1, [ 2, [ 3, [ 4 ] ] ] ];
result = nested.flatten();
writeOutput( result.toString() );

Result: [1, 2, 3, 4]

nested = [ 1, [ 2, [ 3, [ 4 ] ] ] ];
result = nested.flatten( 1 );
writeOutput( result.toString() );

Result: [1, 2, [3, [4]]]

nested = [ 1, [ 2, [ 3, [ 4 ] ] ] ];
result = nested.flatten( 2 );
writeOutput( result.toString() );

Result: [1, 2, 3, [4]]

result = arrayFlatten( [ [ "a", "b" ], [ "c" ] ] );
writeOutput( result.toString() );

Result: [a, b, c]

Last updated 19 days ago

Was this helpful?