![\"deep-eql\"](\"https://raw.githubusercontent.com/chaijs/deep-eql/main/deep-eql-logo.svg\"/){kind=logo}
\n \n\n \n\n Improved deep equality testing for node and the browser.\n
\n\n\n\n## What is Deep-Eql?\n\nDeep Eql is a module which you can use to determine if two objects are \"deeply\" equal - that is, rather than having referential equality (`a === b`), this module checks an object's keys recursively, until it finds primitives to check for referential equality. For more on equality in JavaScript, read [the comparison operators article on mdn](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators).\n\nAs an example, take the following:\n\n```js\n1 === 1 // These are primitives, they hold the same reference - they are strictly equal\n1 == '1' // These are two different primitives, through type coercion they hold the same value - they are loosely equal\n{ a: 1 } !== { a: 1 } // These are two different objects, they hold different references and so are not strictly equal - even though they hold the same values inside\n{ a: 1 } != { a: 1 } // They have the same type, meaning loose equality performs the same check as strict equality - they are still not equal.\n\nvar deepEql = require(\"deep-eql\");\ndeepEql({ a: 1 }, { a: 1 }) === true // deepEql can determine that they share the same keys and those keys share the same values, therefore they are deeply equal!\n```\n\n## Installation\n\n### Node.js\n\n`deep-eql` is available on [npm](http://npmjs.org).\n\n $ npm install deep-eql\n\n## Usage\n\nThe primary export of `deep-eql` is function that can be given two objects to compare. It will always return a boolean which can be used to determine if two objects are deeply equal.\n\n### Rules\n\n- Strict equality for non-traversable nodes according to [`Object.is`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is):\n - `eql(NaN, NaN).should.be.true;`\n - `eql(-0, +0).should.be.false;`\n- All own and inherited enumerable properties are considered:\n - `eql(Object.create({ foo: { a: 1 } }), Object.create({ foo: { a: 1 } })).should.be.true;`\n - `eql(Object.create({ foo: { a: 1 } }), Object.create({ foo: { a: 2 } })).should.be.false;`\n- When comparing `Error` objects, only `name`, `message`, and `code` properties are considered, regardless of enumerability:\n - `eql(Error('foo'), Error('foo')).should.be.true;`\n - `eql(Error('foo'), Error('bar')).should.be.false;`\n - `eql(Error('foo'), TypeError('foo')).should.be.false;`\n - `eql(Object.assign(Error('foo'), { code: 42 }), Object.assign(Error('foo'), { code: 42 })).should.be.true;`\n - `eql(Object.assign(Error('foo'), { code: 42 }), Object.assign(Error('foo'), { code: 13 })).should.be.false;`\n - `eql(Object.assign(Error('foo'), { otherProp: 42 }), Object.assign(Error('foo'), { otherProp: 13 })).should.be.true;`\n- Arguments are not Arrays:\n - `eql([], arguments).should.be.false;`\n - `eql([], Array.prototype.slice.call(arguments)).should.be.true;`\n", "maintainers": [ { "name": "chaijs", "email": "chaijs@keithcirkel.co.uk" }, { "name": "chai", "email": "chaijs@keithcirkel.co.uk" } ], "time": { "modified": "2022-06-27T08:08:48.693Z", "created": "2013-09-18T15:48:42.366Z", "0.1.0": "2013-09-18T15:48:44.262Z", "0.1.1": "2013-09-18T16:05:30.471Z", "0.1.2": "2013-09-18T16:10:10.940Z", "0.1.3": "2013-10-10T10:39:17.348Z", "1.0.0": "2016-10-09T18:17:46.877Z", "1.0.1": "2016-10-18T21:12:45.251Z", "1.0.2": "2016-10-18T22:10:07.464Z", "1.0.3": "2016-10-19T00:37:49.534Z", "2.0.0": "2016-11-03T01:33:09.496Z", "2.0.1": "2016-11-15T00:06:51.565Z", "2.0.2": "2017-05-05T11:19:45.296Z", "3.0.0": "2017-08-05T20:40:35.807Z", "3.0.1": "2017-09-06T21:09:23.075Z", "4.0.0": "2018-10-15T21:39:17.819Z", "4.0.1": "2022-02-28T09:34:33.664Z", "4.1.0": "2022-06-27T08:08:48.621Z" }, "author": { "name": "Jake Luer", "email": "jake@alogicalparadox.com" }, "repository": { "type": "git", "url": "git+ssh://git@github.com/chaijs/deep-eql.git" }, "users": { "pana": true, "erikvold": true, "dpjayasekara": true, "mrzmmr": true, "justjavac": true, "takonyc": true }, "keywords": ["chai util", "deep equal", "object equal", "testing"], "bugs": { "url": "https://github.com/chaijs/deep-eql/issues" }, "license": "MIT", "readmeFilename": "README.md", "homepage": "https://github.com/chaijs/deep-eql#readme", "contributors": [ { "name": "Keith Cirkel", "url": "https://github.com/keithamus" }, { "name": "dougluce", "url": "https://github.com/dougluce" }, { "name": "Lorenz Leutgeb", "url": "https://github.com/flowlo" } ] }