object-deep-compare

A collection of comparison methods for objects in Javascript.

Installation

Using npm:

npm install object-deep-compare

In Node.js:

const objectDeepCompare = require('object-deep-compare');

Dependencies

• lodash

Dev Dependencies

• jest

Library Methods

CompareProperties

This method compares the properties of two objects. It returns all the different and common properties between the two objects.

Example:

const firstObject = {
	foo: 1,
	bar: 2
};
const secondObject = {
	foo: 2,
};

objectDeepCompare.CompareProperties(firstObject, secondObject);
/*
Will return: 
{
	differences: ['bar'],
	common: ['foo']
}
*/

Click here for more examples.

---

CompareArrays

This method compares two arrays for equality. It returns true or false.

Example:

const firstArray = [1, 2];
const secondArray = [1, 2];

objectDeepCompare.CompareArrays(firstArray, secondArray);
/*
Will return: true
*/

Click here for more examples.

---

CompareValuesWithConflicts

This method compares the properties of two objects (deep comparison). It returns an array. Each element in the array is the path of the property that is different.

const firstObject = {
	nested: {
		foo: 1,
		bar: 2
	}
};
const secondObject = {
	nested: {
		foo: 2,
		bar: 4
	}
};

objectDeepCompare.CompareValuesWithConflicts(firstObject, secondObject);
/*
Will return: ['nested.foo', 'nested.bar']
*/

Click here for more examples.

License

MIT © Dean Dumitru