Flattens nested array to given depth.
npm install @extra-array/flatFlattens nested array to given depth.
:package:
:smiley_cat:
:running:
:vhs:
:moon:
:scroll:
:newspaper:
:blue_book:
> Alternatives: [flat], [flatMap].
> This is part of package [extra-array].
[extra-array]: https://www.npmjs.com/package/extra-array
``javascript`
array.flat(x, [n], [fm], [ft]);
// x: a nested array
// n: maximum depth (-1 => all)
// fm: map function (v, i, x)
// ft: test function (v, i, x)
`javascript
const array = require("extra-array");
var x = [[1, 2], [3, [4, [5]]]];
array.flat(x);
// [ 1, 2, 3, 4, 5 ]
array.flat(x, 1);
// [ 1, 2, 3, [ 4, [ 5 ] ] ]
array.flat(x, 2);
// [ 1, 2, 3, 4, [ 5 ] ]
``
- Array.prototype.flat: MDN web docs
- _.flatten: lodash
- _.flattenDeep: lodash
- _.flattenDepth: lodash
- Array.flatten: sugarjs
[flat]: https://github.com/nodef/extra-array/wiki/flat
[flatMap]: https://github.com/nodef/extra-array/wiki/flatMap