dequal

A tiny (304B) utility to check for deep equality

This module supports comparison of all types, including Function, RegExp, Date, null, undefined, and NaN values. Objects and Arrays are traversed recursively.

Please note that key order within Objects does not matter.
However, the value order within Arrays does matter.

This module exposes three module definitions:

• CommonJS: dist/dequal.js
• ESModule: dist/dequal.mjs
• UMD: dist/dequal.min.js

Install

$ npm install --save dequal

Usage

import dequal from 'dequal';

dequal(1, 1); //=> true
dequal({}, {}); //=> true
dequal('foo', 'foo'); //=> true
dequal([1, 2, 3], [1, 2, 3]); //=> true
dequal(dequal, dequal); //=> true
dequal(/foo/, /foo/); //=> true
dequal(null, null); //=> true
dequal(NaN, NaN); //=> true
dequal([], []); //=> true
dequal(
  [{ a:1 }, [{ b:{ c:[1] } }]],
  [{ a:1 }, [{ b:{ c:[1] } }]]
); //=> true

dequal(1, '1'); //=> false
dequal(null, undefined); //=> false
dequal({ a:1, b:[2,3] }, { a:1, b:[2,5] }); //=> false
dequal(/foo/i, /bar/g); //=> false

API

dequal(foo, bar)

Returns: Boolean

Both foo and bar can be of any type.
A Boolean is returned indicating if the two were deeply equal.

Benchmarks

Running Node v10.13.0

Load times:
  assert:            0.166ms
  util:              0.032ms
  fast-deep-equal    0.712ms
  lodash/isequal    24.700ms
  nano-equal         0.506ms
  dequal             0.365ms

Validation:
  ✔ assert.deepStrictEqual
  ✔ util.isDeepStrictEqual
  ✔ fast-deep-equal
  ✔ lodash.isEqual
  ✔ nano-equal
  ✔ dequal

Benchmark:
  assert.deepStrictEqual x 211,987 ops/sec ±1.47% (92 runs sampled)
  util.isDeepStrictEqual x 213,516 ops/sec ±1.25% (93 runs sampled)
  fast-deep-equal        x 479,017 ops/sec ±1.15% (89 runs sampled)
  lodash.isEqual         x 207,120 ops/sec ±0.47% (96 runs sampled)
  nano-equal             x 409,286 ops/sec ±0.73% (97 runs sampled)
  dequal                 x 541,815 ops/sec ±0.95% (94 runs sampled)

License

MIT © Luke Edwards