Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
deep-eql
Advanced tools
Package description
The deep-eql package is a deep equality testing library that allows developers to compare two values for structural equality, rather than just reference equality. It is useful for testing and assertions when you need to ensure that two complex objects, arrays, or other nested structures are equivalent in content.
Deep Equality Check
This feature allows you to check if two objects are deeply equal, meaning their structure and nested values are equivalent.
const deepEql = require('deep-eql');
const obj1 = { a: 1, b: { c: 2 } };
const obj2 = { a: 1, b: { c: 2 } };
console.log(deepEql(obj1, obj2)); // true
Custom Type Comparisons
This feature allows you to provide a custom comparator function to define equality for specific types or instances.
const deepEql = require('deep-eql');
class Person {
constructor(name) {
this.name = name;
}
}
const person1 = new Person('Alice');
const person2 = new Person('Alice');
console.log(deepEql(person1, person2, { comparator: (a, b) => a.name === b.name })); // true
Lodash's isEqual function performs a deep comparison between two values to determine if they are equivalent. It is similar to deep-eql but is part of the larger Lodash utility library, which offers a wide range of functions for manipulating and comparing data.
Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework. It includes a deep equality assertion, similar to deep-eql, as part of its extensive assertion library.
This package provides a function for deep equality checks, similar to deep-eql. It is a standalone library that focuses solely on deep equality without additional dependencies or utilities.
Readme
Improved deep equality testing for node and the browser.
Deep 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.
As an example, take the following:
1 === 1 // These are primitives, they hold the same reference - they are strictly equal
1 == '1' // These are two different primitives, through type coercion they hold the same value - they are loosely equal
{ 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
{ a: 1 } != { a: 1 } // They have the same type, meaning loose equality performs the same check as strict equality - they are still not equal.
var deepEql = require("deep-eql");
deepEql({ 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!
deep-eql
is available on npm.
$ npm install deep-eql
The 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.
Object.is
:
eql(NaN, NaN).should.be.true;
eql(-0, +0).should.be.false;
eql(Object.create({ foo: { a: 1 } }), Object.create({ foo: { a: 1 } })).should.be.true;
eql(Object.create({ foo: { a: 1 } }), Object.create({ foo: { a: 2 } })).should.be.false;
Error
objects, only name
, message
, and code
properties are considered, regardless of enumerability:
eql(Error('foo'), Error('foo')).should.be.true;
eql(Error('foo'), Error('bar')).should.be.false;
eql(Error('foo'), TypeError('foo')).should.be.false;
eql(Object.assign(Error('foo'), { code: 42 }), Object.assign(Error('foo'), { code: 42 })).should.be.true;
eql(Object.assign(Error('foo'), { code: 42 }), Object.assign(Error('foo'), { code: 13 })).should.be.false;
eql(Object.assign(Error('foo'), { otherProp: 42 }), Object.assign(Error('foo'), { otherProp: 13 })).should.be.true;
eql([], arguments).should.be.false;
eql([], Array.prototype.slice.call(arguments)).should.be.true;
FAQs
Improved deep equality testing for Node.js and the browser.
The npm package deep-eql receives a total of 8,335,770 weekly downloads. As such, deep-eql popularity was classified as popular.
We found that deep-eql demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.