---

A small library that can deep diff two JavaScript Objects, including nested structures of arrays and objects.

Installation

yarn add deep-object-diff

npm i --save deep-object-diff

Functions available:

• diff(originalObj, updatedObj) returns the difference of the original and updated objects

• addedDiff(original, updatedObj) returns only the values added to the updated object

• deletedDiff(original, updatedObj) returns only the values deleted in the updated object

• updatedDiff(original, updatedObj) returns only the values that have been changed in the updated object

• detailedDiff(original, updatedObj) returns an object with the added, deleted and updated differences

Importing

1import { diff, addedDiff, deletedDiff, updatedDiff, detailedDiff } from 'deep-object-diff';

Usage:

diff:

1const lhs = {
2  foo: {
3    bar: {
4      a: ['a', 'b'],
5      b: 2,
6      c: ['x', 'y'],
7      e: 100 // deleted
8    }
9  },
10  buzz: 'world'
11};
12
13const rhs = {
14  foo: {
15    bar: {
16      a: ['a'], // index 1 ('b')  deleted
17      b: 2, // unchanged
18      c: ['x', 'y', 'z'], // 'z' added
19      d: 'Hello, world!' // added
20    }
21  },
22  buzz: 'fizz' // updated
23};
24
25console.log(diff(lhs, rhs)); // =>
26/*
27{
28  foo: {
29    bar: {
30      a: {
31        '1': undefined
32      },
33      c: {
34        '2': 'z'
35      },
36      d: 'Hello, world!',
37      e: undefined
38    }
39  },
40  buzz: 'fizz'
41}
42*/

addedDiff:

1const lhs = {
2  foo: {
3    bar: {
4      a: ['a', 'b'],
5      b: 2,
6      c: ['x', 'y'],
7      e: 100 // deleted
8    }
9  },
10  buzz: 'world'
11};
12
13const rhs = {
14  foo: {
15    bar: {
16      a: ['a'], // index 1 ('b')  deleted
17      b: 2, // unchanged
18      c: ['x', 'y', 'z'], // 'z' added
19      d: 'Hello, world!' // added
20    }
21  },
22  buzz: 'fizz' // updated
23};
24
25console.log(addedDiff(lhs, rhs));
26
27/*
28{
29  foo: {
30    bar: {
31      c: {
32        '2': 'z'
33      },
34      d: 'Hello, world!'
35    }
36  }
37}
38*/

deletedDiff:

1const lhs = {
2  foo: {
3    bar: {
4      a: ['a', 'b'],
5      b: 2,
6      c: ['x', 'y'],
7      e: 100 // deleted
8    }
9  },
10  buzz: 'world'
11};
12
13const rhs = {
14  foo: {
15    bar: {
16      a: ['a'], // index 1 ('b')  deleted
17      b: 2, // unchanged
18      c: ['x', 'y', 'z'], // 'z' added
19      d: 'Hello, world!' // added
20    }
21  },
22  buzz: 'fizz' // updated
23};
24
25console.log(deletedDiff(lhs, rhs));
26
27/*
28{
29  foo: {
30    bar: {
31      a: {
32        '1': undefined
33      },
34      e: undefined
35    }
36  }
37}
38*/

updatedDiff:

1const lhs = {
2  foo: {
3    bar: {
4      a: ['a', 'b'],
5      b: 2,
6      c: ['x', 'y'],
7      e: 100 // deleted
8    }
9  },
10  buzz: 'world'
11};
12
13const rhs = {
14  foo: {
15    bar: {
16      a: ['a'], // index 1 ('b')  deleted
17      b: 2, // unchanged
18      c: ['x', 'y', 'z'], // 'z' added
19      d: 'Hello, world!' // added
20    }
21  },
22  buzz: 'fizz' // updated
23};
24
25console.log(updatedDiff(lhs, rhs));
26
27/*
28{
29  buzz: 'fizz'
30}
31*/

detailedDiff:

1const lhs = {
2  foo: {
3    bar: {
4      a: ['a', 'b'],
5      b: 2,
6      c: ['x', 'y'],
7      e: 100 // deleted
8    }
9  },
10  buzz: 'world'
11};
12
13const rhs = {
14  foo: {
15    bar: {
16      a: ['a'], // index 1 ('b')  deleted
17      b: 2, // unchanged
18      c: ['x', 'y', 'z'], // 'z' added
19      d: 'Hello, world!' // added
20    }
21  },
22  buzz: 'fizz' // updated
23};
24
25console.log(detailedDiff(lhs, rhs));
26
27/*
28{
29  added: {
30    foo: {
31      bar: {
32        c: {
33          '2': 'z'
34        },
35        d: 'Hello, world!'
36      }
37    }
38  },
39  deleted: {
40    foo: {
41      bar: {
42        a: {
43          '1': undefined
44        },
45        e: undefined
46      }
47    }
48  },
49  updated: {
50    buzz: 'fizz'
51  }
52}
53*/

License

MIT