dequal

What is dequal?

The dequal npm package is a library for performing deep equality checks. It is a lightweight and fast utility for comparing objects, arrays, and other nested data structures to determine if they are equivalent in value.

What are dequal's main functionalities?

Deep equality check for objects

This feature allows you to compare two objects deeply to check if they are equal in value, regardless of whether they are different instances.

const { dequal } = require('dequal');
let obj1 = { a: 1, b: { c: 2 } };
let obj2 = { a: 1, b: { c: 2 } };
console.log(dequal(obj1, obj2)); // true

Deep equality check for arrays

This feature allows you to compare two arrays deeply to check if they are equal in value, including nested arrays.

const { dequal } = require('dequal');
let arr1 = [1, [2, 3]];
let arr2 = [1, [2, 3]];
console.log(dequal(arr1, arr2)); // true

Deep equality check for mixed structures

This feature allows you to compare mixed data structures like objects containing arrays or arrays containing objects to check for deep equality.

const { dequal } = require('dequal');
let mix1 = { a: [1, { b: 2 }] };
let mix2 = { a: [1, { b: 2 }] };
console.log(dequal(mix1, mix2)); // true

Other packages similar to dequal

lodash.isequal

Lodash's isEqual method is a popular utility for performing deep equality checks. It is part of the larger Lodash library, which provides a wide range of utilities for working with JavaScript data types. Compared to dequal, lodash.isequal is part of a larger bundle and may not be as lightweight if you only need the deep equality functionality.

deep-equal

The deep-equal package is another library that provides deep comparison functionality. It is similar to dequal in that it focuses on deep equality checks, but it may have different performance characteristics and API design.

fast-deep-equal

fast-deep-equal is a package that claims to be the fastest deep equality checker. It is similar to dequal in its purpose but may have different implementation details that could affect performance and compatibility in various use cases.

README

dequal

WIP

Install

$ npm install --save dequal

Usage

const dequal = require('dequal');

//

API

dequal(a, b)

Returns: Boolean

License

MIT © Luke Edwards