# deep-object-diff
> Deep diffs two objects, including nested structures of arrays and objects, and return the difference.
Latest version **1.1.9** (published 2022-11-12) · MIT license · 0 weekly downloads
## Install
```sh
npm install deep-object-diff
pnpm add deep-object-diff
yarn add deep-object-diff
bun add deep-object-diff
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.9 |
| Published | 2022-11-12 |
| First published | 2016-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1139 |
| Author | Matt Phillips |
| Maintainers | mattphillips |
| Keywords | diff, object, deep, difference |
## Links
- npm: https://www.npmjs.com/package/deep-object-diff
- Repository: https://github.com/mattphillips/deep-object-diff
- Homepage: https://github.com/mattphillips/deep-object-diff#readme
- Issues: https://github.com/mattphillips/deep-object-diff/issues
- npm.io page: https://npm.io/package/deep-object-diff
## Recent versions
- 1.1.9 (latest) — 2022-11-12
- 1.1.8 — 2022-11-12
- 1.1.7 — 2022-01-25
- 1.1.6 — 2022-01-25
- 1.1.5 — 2022-01-25
- 1.1.4 — 2022-01-25
- 1.1.3 — 2022-01-25
- 1.1.2 — 2022-01-25
- 1.1.1 — 2022-01-25
- 1.1.0 — 2018-02-01
- 1.0.4 — 2017-06-17
- 1.0.3 — 2017-04-11
- 1.0.2 — 2017-03-01
- 1.0.1 — 2017-02-14
- 1.0.0 — 2017-01-26
- … 4 more at https://npm.io/package/deep-object-diff/versions
## README
deep-object-diff
❄️
Deep diff two JavaScript Objects
[](https://github.com/mattphillips/deep-object-diff/actions/workflows/ci.yaml)
[](https://codecov.io/gh/mattphillips/deep-object-diff)
[](https://www.npmjs.com/package/deep-object-diff)
[](http://npm-stat.com/charts.html?package=deep-object-diff&from=2016-11-23)
[](https://github.com/mattphillips/deep-object-diff/blob/master/LICENSE)
[](http://makeapullrequest.com)
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)`](#diff)
returns the difference of the original and updated objects
- [`addedDiff(original, updatedObj)`](#addeddiff)
returns only the values added to the updated object
- [`deletedDiff(original, updatedObj)`](#deleteddiff)
returns only the values deleted in the updated object
- [`updatedDiff(original, updatedObj)`](#updateddiff)
returns only the values that have been changed in the updated object
- [`detailedDiff(original, updatedObj)`](#detaileddiff)
returns an object with the added, deleted and updated differences
## Importing
``` js
import { diff, addedDiff, deletedDiff, updatedDiff, detailedDiff } from 'deep-object-diff';
```
## Usage:
### `diff`:
```js
const lhs = {
foo: {
bar: {
a: ['a', 'b'],
b: 2,
c: ['x', 'y'],
e: 100 // deleted
}
},
buzz: 'world'
};
const rhs = {
foo: {
bar: {
a: ['a'], // index 1 ('b') deleted
b: 2, // unchanged
c: ['x', 'y', 'z'], // 'z' added
d: 'Hello, world!' // added
}
},
buzz: 'fizz' // updated
};
console.log(diff(lhs, rhs)); // =>
/*
{
foo: {
bar: {
a: {
'1': undefined
},
c: {
'2': 'z'
},
d: 'Hello, world!',
e: undefined
}
},
buzz: 'fizz'
}
*/
```
### `addedDiff`:
```js
const lhs = {
foo: {
bar: {
a: ['a', 'b'],
b: 2,
c: ['x', 'y'],
e: 100 // deleted
}
},
buzz: 'world'
};
const rhs = {
foo: {
bar: {
a: ['a'], // index 1 ('b') deleted
b: 2, // unchanged
c: ['x', 'y', 'z'], // 'z' added
d: 'Hello, world!' // added
}
},
buzz: 'fizz' // updated
};
console.log(addedDiff(lhs, rhs));
/*
{
foo: {
bar: {
c: {
'2': 'z'
},
d: 'Hello, world!'
}
}
}
*/
```
### `deletedDiff`:
```js
const lhs = {
foo: {
bar: {
a: ['a', 'b'],
b: 2,
c: ['x', 'y'],
e: 100 // deleted
}
},
buzz: 'world'
};
const rhs = {
foo: {
bar: {
a: ['a'], // index 1 ('b') deleted
b: 2, // unchanged
c: ['x', 'y', 'z'], // 'z' added
d: 'Hello, world!' // added
}
},
buzz: 'fizz' // updated
};
console.log(deletedDiff(lhs, rhs));
/*
{
foo: {
bar: {
a: {
'1': undefined
},
e: undefined
}
}
}
*/
```
### `updatedDiff`:
```js
const lhs = {
foo: {
bar: {
a: ['a', 'b'],
b: 2,
c: ['x', 'y'],
e: 100 // deleted
}
},
buzz: 'world'
};
const rhs = {
foo: {
bar: {
a: ['a'], // index 1 ('b') deleted
b: 2, // unchanged
c: ['x', 'y', 'z'], // 'z' added
d: 'Hello, world!' // added
}
},
buzz: 'fizz' // updated
};
console.log(updatedDiff(lhs, rhs));
/*
{
buzz: 'fizz'
}
*/
```
### `detailedDiff`:
```js
const lhs = {
foo: {
bar: {
a: ['a', 'b'],
b: 2,
c: ['x', 'y'],
e: 100 // deleted
}
},
buzz: 'world'
};
const rhs = {
foo: {
bar: {
a: ['a'], // index 1 ('b') deleted
b: 2, // unchanged
c: ['x', 'y', 'z'], // 'z' added
d: 'Hello, world!' // added
}
},
buzz: 'fizz' // updated
};
console.log(detailedDiff(lhs, rhs));
/*
{
added: {
foo: {
bar: {
c: {
'2': 'z'
},
d: 'Hello, world!'
}
}
},
deleted: {
foo: {
bar: {
a: {
'1': undefined
},
e: undefined
}
}
},
updated: {
buzz: 'fizz'
}
}
*/
```
## License
MIT
---
_Source: https://npm.io/package/deep-object-diff · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._