hyperdiff

hyperdiff

Find common, removed and added element between two collections.

Install

$ npm install hyperdiff --save

Usage

Using a flat Array:

const diff = require('hyperdiff')

var result = diff(
  [1, 2, 3, 4, 5, 6],
  [1, 2, 4, 5, 6, 0, 9, 10]
)

console.log(result)

// {
//   added: [ 0, 9, 10 ],
//   removed: [ 3 ],
//   common: [ 1, 2, 4, 5, 6 ]
// }

Using an Array of Object's (in this case you need to provide the unique id):

const diff = require('hyperdiff')
var result = diff(
  [
    {id: 1, name: 'a'},
    {id: 2, name: 'b'},
    {id: 3, name: 'c'},
    {id: 4, name: 'd'},
    {id: 5, name: 'e'}
  ],
  [
    {id: 1, name: 'a'},
    {id: 2, name: 'b'},
    {id: 7, name: 'e'}
  ],
  'id'
)

console.log(result)
// {
//   added: [ { id: 7, name: 'e' } ],
//   removed: [ { id: 3, name: 'c' }, { id: 4, name: 'd' }, { id: 5, name: 'e' } ],
//   common: [ { id: 1, name: 'a' }, { id: 2, name: 'b' } ]
// }

It's also support multiple properties as id or provide a function.

Benchmark

❯ node bench.js
simpleArrayDiff*1000: 143.742ms
hyperDiff*1000: 80.234ms
simpleArrayDiff*1000: 143.405ms
hyperDiff*1000: 75.803ms

API

hyperdiff(orig, dist, [ids])

orig

Required
Type: array

First array for be compared.

dist

Required
Type: array

Second array for be compared. Notes the results are modeled from the second array.

ids

Required
Type: string|array|function

In the case that you provide an Array of Object's, you need to specify the key's to be used as id.

Related

• redis-diff - Perform a diff comparison backed by redis.

License

MIT © Kiko Beats.

Changelog

2.0.4 (2017-12-01)

• Update compositor.json (330238b)
• Update README.md (7bcd8db)
• docs(readme): add Greenkeeper badge (0b12b2c)
• fix(package): update debug to version 3.1.0 (de5a00a)

<a name="2.0.3"></a>