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 |
|
3 | > Combines a list of arrays, returning a single array with unique values, using strict equality for comparisons.
|
4 |
|
5 | ## Install
|
6 |
|
7 | Install with [npm](https://www.npmjs.com/):
|
8 |
|
9 | ```sh
|
10 | $ npm i arr-union --save
|
11 | ```
|
12 |
|
13 | ## Benchmarks
|
14 |
|
15 | This library is **10-20 times faster** and more performant than [array-union](https://github.com/sindresorhus/array-union).
|
16 |
|
17 | See the [benchmarks](./benchmark).
|
18 |
|
19 | ```sh
|
20 | #1: five-arrays
|
21 | array-union x 511,121 ops/sec ±0.80% (96 runs sampled)
|
22 | arr-union x 5,716,039 ops/sec ±0.86% (93 runs sampled)
|
23 |
|
24 | #2: ten-arrays
|
25 | array-union x 245,196 ops/sec ±0.69% (94 runs sampled)
|
26 | arr-union x 1,850,786 ops/sec ±0.84% (97 runs sampled)
|
27 |
|
28 | #3: two-arrays
|
29 | array-union x 563,869 ops/sec ±0.97% (94 runs sampled)
|
30 | arr-union x 9,602,852 ops/sec ±0.87% (92 runs sampled)
|
31 | ```
|
32 |
|
33 | ## Usage
|
34 |
|
35 | ```js
|
36 | var union = require('arr-union');
|
37 |
|
38 | union(['a'], ['b', 'c'], ['d', 'e', 'f']);
|
39 | //=> ['a', 'b', 'c', 'd', 'e', 'f']
|
40 | ```
|
41 |
|
42 | Returns only unique elements:
|
43 |
|
44 | ```js
|
45 | union(['a', 'a'], ['b', 'c']);
|
46 | //=> ['a', 'b', 'c']
|
47 | ```
|
48 |
|
49 | ## Related projects
|
50 |
|
51 | * [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)
|
52 | * [arr-filter](https://www.npmjs.com/package/arr-filter): Faster alternative to javascript's native filter method. | [homepage](https://github.com/jonschlinkert/arr-filter)
|
53 | * [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)
|
54 | * [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)
|
55 | * [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)
|
56 | * [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)
|
57 | * [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)
|
58 |
|
59 | ## Contributing
|
60 |
|
61 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/arr-union/issues/new).
|
62 |
|
63 | ## Building docs
|
64 |
|
65 | Generate readme and API documentation with [verb](https://github.com/verbose/verb):
|
66 |
|
67 | ```sh
|
68 | $ npm i verb && npm run docs
|
69 | ```
|
70 |
|
71 | Or, if [verb](https://github.com/verbose/verb) is installed globally:
|
72 |
|
73 | ```sh
|
74 | $ verb
|
75 | ```
|
76 |
|
77 | ## Running tests
|
78 |
|
79 | Install dev dependencies:
|
80 |
|
81 | ```sh
|
82 | $ npm i -d && npm test
|
83 | ```
|
84 |
|
85 | ## Author
|
86 |
|
87 | **Jon Schlinkert**
|
88 |
|
89 | * [github/jonschlinkert](https://github.com/jonschlinkert)
|
90 | * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
|
91 |
|
92 | ## License
|
93 |
|
94 | Copyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)
|
95 | Released under the [MIT license](https://github.com/jonschlinkert/arr-union/blob/master/LICENSE).
|
96 |
|
97 | ***
|
98 |
|
99 | _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on February 23, 2016._ |
\ | No newline at end of file |