You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

98 lines
3.5 KiB

4 years ago
  1. # arr-union [![NPM version](https://img.shields.io/npm/v/arr-union.svg)](https://www.npmjs.com/package/arr-union) [![Build Status](https://img.shields.io/travis/jonschlinkert/arr-union.svg)](https://travis-ci.org/jonschlinkert/arr-union)
  2. > Combines a list of arrays, returning a single array with unique values, using strict equality for comparisons.
  3. ## Install
  4. Install with [npm](https://www.npmjs.com/):
  5. ```sh
  6. $ npm i arr-union --save
  7. ```
  8. ## Benchmarks
  9. This library is **10-20 times faster** and more performant than [array-union](https://github.com/sindresorhus/array-union).
  10. See the [benchmarks](./benchmark).
  11. ```sh
  12. #1: five-arrays
  13. array-union x 511,121 ops/sec ±0.80% (96 runs sampled)
  14. arr-union x 5,716,039 ops/sec ±0.86% (93 runs sampled)
  15. #2: ten-arrays
  16. array-union x 245,196 ops/sec ±0.69% (94 runs sampled)
  17. arr-union x 1,850,786 ops/sec ±0.84% (97 runs sampled)
  18. #3: two-arrays
  19. array-union x 563,869 ops/sec ±0.97% (94 runs sampled)
  20. arr-union x 9,602,852 ops/sec ±0.87% (92 runs sampled)
  21. ```
  22. ## Usage
  23. ```js
  24. var union = require('arr-union');
  25. union(['a'], ['b', 'c'], ['d', 'e', 'f']);
  26. //=> ['a', 'b', 'c', 'd', 'e', 'f']
  27. ```
  28. Returns only unique elements:
  29. ```js
  30. union(['a', 'a'], ['b', 'c']);
  31. //=> ['a', 'b', 'c']
  32. ```
  33. ## Related projects
  34. * [arr-diff](https://www.npmjs.com/package/arr-diff): Returns an array with only the unique values from the first array, by excluding all… [more](https://www.npmjs.com/package/arr-diff) | [homepage](https://github.com/jonschlinkert/arr-diff)
  35. * [arr-filter](https://www.npmjs.com/package/arr-filter): Faster alternative to javascript's native filter method. | [homepage](https://github.com/jonschlinkert/arr-filter)
  36. * [arr-flatten](https://www.npmjs.com/package/arr-flatten): Recursively flatten an array or arrays. This is the fastest implementation of array flatten. | [homepage](https://github.com/jonschlinkert/arr-flatten)
  37. * [arr-map](https://www.npmjs.com/package/arr-map): Faster, node.js focused alternative to JavaScript's native array map. | [homepage](https://github.com/jonschlinkert/arr-map)
  38. * [arr-pluck](https://www.npmjs.com/package/arr-pluck): Retrieves the value of a specified property from all elements in the collection. | [homepage](https://github.com/jonschlinkert/arr-pluck)
  39. * [arr-reduce](https://www.npmjs.com/package/arr-reduce): Fast array reduce that also loops over sparse elements. | [homepage](https://github.com/jonschlinkert/arr-reduce)
  40. * [array-unique](https://www.npmjs.com/package/array-unique): Return an array free of duplicate values. Fastest ES5 implementation. | [homepage](https://github.com/jonschlinkert/array-unique)
  41. ## Contributing
  42. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/arr-union/issues/new).
  43. ## Building docs
  44. Generate readme and API documentation with [verb](https://github.com/verbose/verb):
  45. ```sh
  46. $ npm i verb && npm run docs
  47. ```
  48. Or, if [verb](https://github.com/verbose/verb) is installed globally:
  49. ```sh
  50. $ verb
  51. ```
  52. ## Running tests
  53. Install dev dependencies:
  54. ```sh
  55. $ npm i -d && npm test
  56. ```
  57. ## Author
  58. **Jon Schlinkert**
  59. * [github/jonschlinkert](https://github.com/jonschlinkert)
  60. * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  61. ## License
  62. Copyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)
  63. Released under the [MIT license](https://github.com/jonschlinkert/arr-union/blob/master/LICENSE).
  64. ***
  65. _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on February 23, 2016._