arr-flatten

What is arr-flatten?

The arr-flatten npm package is a utility for flattening nested arrays into a single-level array. It is a simple and focused package that does not handle arguments other than arrays (e.g., it does not flatten array-like objects).

What are arr-flatten's main functionalities?

Flatten nested arrays

This feature allows you to flatten a deeply nested array into a single-level array. The code sample demonstrates how to use the `.flat()` method to flatten an array with multiple levels of nesting.

[1, [2, [3, [4]], 5]].flat()

Other packages similar to arr-flatten

lodash.flatten

Lodash provides a method called `flatten` that can flatten arrays up to one level deep. It is part of the larger Lodash library, which offers a wide range of utilities for working with arrays, objects, and other types. Compared to arr-flatten, lodash.flatten is part of a larger utility library and may not be as lightweight if you only need to flatten arrays.

flat

The `flat` package offers functionality to flatten arrays with additional options, such as specifying the depth to which the array should be flattened. It can also flatten array-like objects, unlike arr-flatten. This package provides more flexibility and features compared to arr-flatten, which is more minimalistic.

README

arr-flatten

Recursively flatten an array or arrays.

Install

Install with npm:

$ npm install --save arr-flatten

Install

Install with bower

$ bower install arr-flatten --save

Usage

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: Faster alternative to javascript's native filter method. | homepage
• arr-union: Combines a list of arrays, returning a single array with unique values, using strict equality… more | homepage
• array-each: Loop over each item in an array and call the given function on every element. | homepage
• array-unique: Remove duplicate values from an array. Fastest ES5 implementation. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
20	jonschlinkert
1	lukeed

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on July 05, 2017.