diff options
Diffstat (limited to 'node_modules/arr-flatten/README.md')
| -rwxr-xr-x | node_modules/arr-flatten/README.md | 100 |
1 files changed, 56 insertions, 44 deletions
diff --git a/node_modules/arr-flatten/README.md b/node_modules/arr-flatten/README.md index bd696e660..71c1d3b4c 100755 --- a/node_modules/arr-flatten/README.md +++ b/node_modules/arr-flatten/README.md @@ -1,73 +1,85 @@ -# arr-flatten [](http://badge.fury.io/js/arr-flatten) [](https://travis-ci.org/jonschlinkert/arr-flatten) +# arr-flatten [](https://www.npmjs.com/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. This is the fastest implementation of array flatten. +> Recursively flatten an array or arrays. -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%. +## Install -## Run benchmarks +Install with [npm](https://www.npmjs.com/): -```bash -npm run benchmarks +```sh +$ npm install --save arr-flatten ``` -Benchmark results comparing this library to [array-flatten]: +Install with [yarn](https://yarnpkg.com): -```bash -#1: large.js - arr-flatten.js x 487,030 ops/sec ±0.67% (92 runs sampled) - array-flatten.js x 347,020 ops/sec ±0.57% (98 runs sampled) +```sh +$ yarn add arr-flatten +``` + +## Install -#2: medium.js - arr-flatten.js x 1,914,516 ops/sec ±0.76% (94 runs sampled) - array-flatten.js x 1,391,661 ops/sec ±0.63% (96 runs sampled) +Install with [bower](https://bower.io/) -#3: small.js - arr-flatten.js x 5,158,980 ops/sec ±0.85% (94 runs sampled) - array-flatten.js x 3,683,173 ops/sec ±0.79% (97 runs sampled) +```sh +$ bower install arr-flatten --save ``` -## Run tests +## Usage -Install dev dependencies: +```js +var flatten = require('arr-flatten'); -```bash -npm i -d && npm test +flatten(['a', ['b', ['c']], 'd', ['e']]); +//=> ['a', 'b', 'c', 'd', 'e'] ``` -## Install with [npm](npmjs.org) +## Why another flatten utility? -```bash -npm i arr-flatten --save -``` -### Install with [bower](https://github.com/bower/bower) +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%. -```bash -bower install arr-flatten --save -``` +## About +### Related projects -## Usage +* [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.") -```js -var flatten = require('arr-flatten'); +### Contributing -flatten(['a', ['b', ['c']], 'd', ['e']]); -//=> ['a', 'b', 'c', 'd', 'e'] +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +### 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 +### Author **Jon Schlinkert** - -+ [github/jonschlinkert](https://github.com/jonschlinkert) -+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert) -## License -Copyright (c) 2014-2015 Jon Schlinkert -Released under the MIT license +* [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-cli](https://github.com/assemble/verb-cli) on March 11, 2015._ +*** -[array-flatten]: https://github.com/blakeembrey/array-flatten
\ No newline at end of file +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 16, 2017._
\ No newline at end of file |