| # arr-flatten [](https://www.npmjs.com/package/arr-flatten) [](https://npmjs.org/package/arr-flatten) [](https://npmjs.org/package/arr-flatten) [](https://travis-ci.org/jonschlinkert/arr-flatten) [](https://ci.appveyor.com/project/jonschlinkert/arr-flatten) |
| |
| > Recursively flatten an array or arrays. |
| |
| ## Install |
| |
| Install with [npm](https://www.npmjs.com/): |
| |
| ```sh |
| $ npm install --save arr-flatten |
| ``` |
| |
| ## Install |
| |
| Install with [bower](https://bower.io/) |
| |
| ```sh |
| $ bower install arr-flatten --save |
| ``` |
| |
| ## Usage |
| |
| ```js |
| var flatten = require('arr-flatten'); |
| |
| flatten(['a', ['b', ['c']], 'd', ['e']]); |
| //=> ['a', 'b', 'c', 'd', 'e'] |
| ``` |
| |
| ## Why another flatten utility? |
| |
| I wanted the fastest implementation I could find, with implementation choices that should work for 95% of use cases, but no cruft to cover the other 5%. |
| |
| ## About |
| |
| ### Related projects |
| |
| * [arr-filter](https://www.npmjs.com/package/arr-filter): Faster alternative to javascript's native filter method. | [homepage](https://github.com/jonschlinkert/arr-filter "Faster alternative to javascript's native filter method.") |
| * [arr-union](https://www.npmjs.com/package/arr-union): Combines a list of arrays, returning a single array with unique values, using strict equality… [more](https://github.com/jonschlinkert/arr-union) | [homepage](https://github.com/jonschlinkert/arr-union "Combines a list of arrays, returning a single array with unique values, using strict equality for comparisons.") |
| * [array-each](https://www.npmjs.com/package/array-each): Loop over each item in an array and call the given function on every element. | [homepage](https://github.com/jonschlinkert/array-each "Loop over each item in an array and call the given function on every element.") |
| * [array-unique](https://www.npmjs.com/package/array-unique): Remove duplicate values from an array. Fastest ES5 implementation. | [homepage](https://github.com/jonschlinkert/array-unique "Remove duplicate values from an array. Fastest ES5 implementation.") |
| |
| ### Contributing |
| |
| Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). |
| |
| ### Contributors |
| |
| | **Commits** | **Contributor** | |
| | --- | --- | |
| | 20 | [jonschlinkert](https://github.com/jonschlinkert) | |
| | 1 | [lukeed](https://github.com/lukeed) | |
| |
| ### Building docs |
| |
| _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ |
| |
| To generate the readme, run the following command: |
| |
| ```sh |
| $ npm install -g verbose/verb#dev verb-generate-readme && verb |
| ``` |
| |
| ### Running tests |
| |
| Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: |
| |
| ```sh |
| $ npm install && npm test |
| ``` |
| |
| ### Author |
| |
| **Jon Schlinkert** |
| |
| * [github/jonschlinkert](https://github.com/jonschlinkert) |
| * [twitter/jonschlinkert](https://twitter.com/jonschlinkert) |
| |
| ### License |
| |
| Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). |
| Released under the [MIT License](LICENSE). |
| |
| *** |
| |
| _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 05, 2017._ |
