What is arr-diff?
The arr-diff npm package is used to compute the difference between one or more arrays, returning an array that contains the values from the first array that are not present in the other arrays.
What are arr-diff's main functionalities?
Basic array difference
This feature allows you to find the elements that are present in the first array but not in the subsequent arrays. The code sample demonstrates how to use arr-diff to filter out the numbers 2 and 4 from the array [1, 2, 3, 4, 5], resulting in [1, 3, 5].
[1, 2, 3, 4, 5].filter(arrDiff([2, 4]))
Multiple array difference
This feature is used to find the difference between one array and multiple other arrays. The code sample shows how to use arr-diff to filter out the numbers 2, 3, 4, and 5 from the array [1, 2, 3, 4, 5], resulting in [1].
[1, 2, 3, 4, 5].filter(arrDiff([2, 3], [4, 5]))
Other packages similar to arr-diff
lodash.difference
Lodash's difference function is similar to arr-diff. It creates an array of array values not included in the other given arrays using SameValueZero for equality comparisons. Lodash is a more extensive utility library that includes a wide range of functions for different purposes.
underscore
Underscore.js is a utility library that offers the _.difference function, which is similar to arr-diff's functionality. It returns the values from the first array that are not present in the other arrays. Underscore.js provides a more comprehensive set of utility functions beyond array manipulation.
ramda
Ramda is a functional programming library that includes a difference function, which behaves similarly to arr-diff. It focuses on a more functional programming approach and offers a suite of tools for this paradigm.
arr-diff
Returns an array with only the unique values from the first array, by excluding all values from additional arrays using strict equality for comparisons.
Install
Install with npm:
$ npm install --save arr-diff
Install with yarn:
$ yarn add arr-diff
Install with bower
$ bower install arr-diff --save
Usage
Returns the difference between the first array and additional arrays.
var diff = require('arr-diff');
var a = ['a', 'b', 'c', 'd'];
var b = ['b', 'c'];
console.log(diff(a, b))
Benchmarks
This library versus array-differ, on April 14, 2017:
Benchmarking: (4 of 4)
· long-dupes
· long
· med
· short
# benchmark/fixtures/long-dupes.js (100804 bytes)
arr-diff-3.0.0 x 822 ops/sec ±0.67% (86 runs sampled)
arr-diff-4.0.0 x 2,141 ops/sec ±0.42% (89 runs sampled)
array-differ x 708 ops/sec ±0.70% (89 runs sampled)
fastest is arr-diff-4.0.0
# benchmark/fixtures/long.js (94529 bytes)
arr-diff-3.0.0 x 882 ops/sec ±0.60% (87 runs sampled)
arr-diff-4.0.0 x 2,329 ops/sec ±0.97% (83 runs sampled)
array-differ x 769 ops/sec ±0.61% (90 runs sampled)
fastest is arr-diff-4.0.0
# benchmark/fixtures/med.js (708 bytes)
arr-diff-3.0.0 x 856,150 ops/sec ±0.42% (89 runs sampled)
arr-diff-4.0.0 x 4,665,249 ops/sec ±1.06% (89 runs sampled)
array-differ x 653,888 ops/sec ±1.02% (86 runs sampled)
fastest is arr-diff-4.0.0
# benchmark/fixtures/short.js (60 bytes)
arr-diff-3.0.0 x 3,078,467 ops/sec ±0.77% (93 runs sampled)
arr-diff-4.0.0 x 9,213,296 ops/sec ±0.65% (89 runs sampled)
array-differ x 1,337,051 ops/sec ±0.91% (92 runs sampled)
fastest is arr-diff-4.0.0
About
Related projects
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Contributors
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
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
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
This file was generated by verb-generate-readme, v0.5.0, on April 14, 2017.