jonschlinkert / arr-flatten Goto Github PK

View Code? Open in Web Editor NEW

59.0 6.0 16.0 24 KB

Recursively flatten an array or arrays. This is the fastest implementation of array flatten.

Home Page: https://github.com/jonschlinkert

License: MIT License

JavaScript 100.00%

array flatten util utility javascript microlib nodejs nested

arr-flatten's Introduction

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

License

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

arr-flatten's People

Contributors

Stargazers

Watchers

Forkers

mattmontgomery flyeven lukeed blackhole1 zhouping3 silicon-beach-labs macchiosilver genisysram sreekanth370 coosigma mpadev0103 popular-dependencies thunderqin

arr-flatten's Issues

Update benchmarks

Hey! I just found this and you're right about the depth argument. I did a bit of testing before this and found it wasn't quite that big of a slowdown, but the array-flatten is faster without it so I implemented a shorter code path for when it's undefined. That changed the benchmark here somewhat.

#1: large 
  current x 426,603 ops/sec ±2.21% (88 runs sampled)
  lib-array-flatten x 427,445 ops/sec ±2.76% (90 runs sampled)

  fastest is lib-array-flatten
#2: medium 
  current x 1,860,941 ops/sec ±1.41% (88 runs sampled)
  lib-array-flatten x 1,753,099 ops/sec ±2.32% (88 runs sampled)

  fastest is current
#3: small 
  current x 5,005,209 ops/sec ±1.36% (86 runs sampled)
  lib-array-flatten x 5,473,100 ops/sec ±2.77% (89 runs sampled)

  fastest is lib-array-flatten

Run with [email protected]. The benchmark tends to frequently switch between current or lib-array-flatten.

Nested TypedArrays

Right now they are ignored.
Is that expected behavior?

flat([[0,0,0,0], new Uint8Array([0,0,0,0])]) // [0,0,0,0]

Very deep nested array will cause maximum call stack size exceeded

Test case:

assert.deepEqual(flatten([['a', [[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]], ['b', ['k', ['a', ['b', ['c'], [['a', [['a', ['b', ['k', ['a', ['b', ['c']], ['a', ['x', ['c'], ['a', ['x', ['k']]], ['d', ['z']]]], ['d', ['m']]], ['d', ['e']]]]], ['d', ['e']]], ['b', ['k', ['a', ['b', ['c']], ['a', ['x', ['c'], ['a', ['x', ['k']]], ['d', ['z']]]], ['d', ['m']]], ['d', ['e']]]]], ['d', ['e']]]], ['a', ['x', ['c'], ['a', ['x', ['k']], [['a', ['b', ['k', ['a', ['b', ['c']], ['a', ['x', ['c'], ['a', ['x', ['k']]], ['d', ['z']]]], ['d', ['m']]], ['d', ['e']]]]], ['d', ['e']]]], ['d', ['z']]]], ['d', ['m']]], ['d', ['e']]]]], ['d', ['e']]]), [ 'a', 'b', 'k', 'a', 'b', 'c', 'a', 'a', 'b', 'k', 'a', 'b', 'c', 'a', 'x', 'c', 'a', 'x', 'k', 'd', 'z', 'd', 'm', 'd', 'e', 'd', 'e', 'b', 'k', 'a', 'b', 'c', 'a', 'x', 'c', 'a', 'x', 'k', 'd', 'z', 'd', 'm', 'd', 'e', 'd', 'e', 'a', 'x', 'c', 'a', 'x', 'k', 'a', 'b', 'k', 'a', 'b', 'c', 'a', 'x', 'c', 'a', 'x', 'k', 'd', 'z', 'd', 'm', 'd', 'e', 'd', 'e', 'd', 'z', 'd', 'm', 'd', 'e', 'd', 'e' ]);

Error:

vm.js:74
  return new Script(code, options);
         ^

RangeError: Maximum call stack size exceeded
    at createScript (vm.js:74:10)
    at Object.runInThisContext (vm.js:116:10)
    at Module._compile (module.js:588:28)
    at Object.Module._extensions..js (module.js:635:10)
    at Module.load (module.js:545:32)
    at tryModuleLoad (module.js:508:12)
    at Function.Module._load (module.js:500:3)
    at Module.require (module.js:568:17)
    at require (internal/module.js:11:18)
    at ./node_modules/mocha/lib/mocha.js:231:27
    at Array.forEach (<anonymous>)
    at Mocha.loadFiles (./node_modules/mocha/lib/mocha.js:228:14)
    at Mocha.run (./node_modules/mocha/lib/mocha.js:514:10)
    at Object.<anonymous> (./node_modules/mocha/bin/_mocha:480:18)
    at Module._compile (module.js:624:30)
    at Object.Module._extensions..js (module.js:635:10)
    at Module.load (module.js:545:32)
    at tryModuleLoad (module.js:508:12)
    at Function.Module._load (module.js:500:3)
    at Function.Module.runMain (module.js:665:10)
    at startup (bootstrap_node.js:201:16)
    at bootstrap_node.js:626:3
npm ERR! Test failed.  See above for more details.

deprecate npm package?

just use [].flat(infinity) instead

jonschlinkert / arr-flatten Goto Github PK

arr-flatten's Introduction

arr-flatten

Install

Install

Usage

Why another flatten utility?

About

Related projects

Contributing

Contributors

Building docs

Running tests

Author

License

arr-flatten's People

Contributors

Stargazers

Watchers

Forkers

arr-flatten's Issues

Recommend Projects

Recommend Topics

Recommend Org