Usage

`javascript
var flattenArray = require( '@stdlib/utils-flatten-array' );
`

#### flattenArray( arr\[, options] )

Flattens an array.

`javascript
var arr = [ 1, [2, [3, [4, [ 5 ], 6], 7], 8], 9 ];

var out = flattenArray( arr );
// returns [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
`

The function accepts the following options:

- depth: maximum depth to flatten.
- copy: boolean indicating whether to deep [copy][@stdlib/utils/copy] array elements. Default: false.

To flatten to a specified depth, set the depth option.

`javascript
var arr = [ 1, [2, [3, [4, [ 5 ], 6], 7], 8], 9 ];

var out = flattenArray( arr, {
'depth': 2
});
// returns [ 1, 2, 3, [4, [5], 6], 7, 8, 9 ]

var bool = ( arr[1][1][1] === out[3] );
// returns true
`

To deep [copy][@stdlib/utils/copy] array elements, set the copy option to true.

`javascript
var arr = [ 1, [2, [3, [4, [ 5 ], 6], 7], 8], 9 ];

var out = flattenArray( arr, {
'depth': 2,
'copy': true
});
// returns [ 1, 2, 3, [4, [5], 6], 7, 8, 9 ]

var bool = ( arr[1][1][1] === out[3] );
// returns false
`

#### flattenArray.factory( dims\[, options] )

Returns a function optimized for flattening arrays having specified dimensions.

`javascript
var flatten = flattenArray.factory( [ 3, 3 ] );

var arr = [
[ 1, 2, 3 ],
[ 4, 5, 6 ],
[ 7, 8, 9 ]
];

var out = flatten( arr );
// returns [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]

arr = [
[ 11, 12, 13 ],
[ 14, 15, 16 ],
[ 17, 18, 19 ]
];

out = flatten( arr );
// returns [ 11, 12, 13, 14, 15, 16, 17, 18, 19 ]
`

The function accepts the following options:

- copy: boolean indicating whether to deep [copy][@stdlib/utils/copy] array elements. Default: false.

To deep [copy][@stdlib/utils/copy] array elements, set the copy option to true.

`javascript
var flatten = flattenArray.factory( [ 3, 3 ], {
'copy': true
});

var arr = [
[ 1, 2, 3 ],
[ 4, { 'x': 5 }, 6 ],
[ 7, 8, 9 ]
];

var out = flatten( arr );
// returns [ 1, 2, 3, 4, {'x':5}, 6, 7, 8, 9 ]

var bool = ( arr[1][1] === out[4] );
// returns false
`