Performs a deep comparison between two values to determine if they are equivalent. Objects are compared by their own enumerable properties. Since Lodash 0.1.0.
Pass the value you want to inspect or convert. Read the return type carefully before you use the result.
Call _.isEqual. Start with this line.
_.isEqual(value, other)| Call | What it does |
|---|---|
_.isEqual(value, other) | Primary signature. |
_.isEqual(value) | Check, compare, clone, or convert a value. |
Prefer import isEqual from "lodash/isEqual" when you want a smaller bundle.
_.isEqual(value, other)| Parameter | Description |
|---|---|
| value | Required. First value to compare |
| other | Required. Second value to compare |
| Return Value | Description |
|---|---|
| * | true if equivalent, else false |
===Same shape, different references — deep equal wins.
var object = { a: 1 };
var other = { a: 1 };
_.isEqual(object, other);
// → true
object === other;
// → falsefalse.a → both 1.true.Deep walk compares nested structure.
var a = { user: { id: 7, roles: ["admin", "editor"] } };
var b = { user: { id: 7, roles: ["admin", "editor"] } };
_.isEqual(a, b);
// → true
_.isEqual(a, { user: { id: 7, roles: ["editor", "admin"] } });
// → false // array order mattersroles → equal.Dates compare by time value, not by reference.
_.isEqual(new Date(0), new Date(0));
// → true
_.isEqual(new Date(0), new Date(1));
// → falsefalse even for same ms (different refs).NaN Equals NaNUnlike ===, deep equal treats NaN as matching NaN.
NaN === NaN;
// → false
_.isEqual(NaN, NaN);
// → trueNaN never equals itself.true for NaN vs NaN.Identical source text is not enough — same reference required.
function greet() { return "hi"; }
var copy = function () { return "hi"; };
_.isEqual(greet, greet);
// → true
_.isEqual(greet, copy);
// → false===, not source compare._.isEqual is a Lodash Lang helper (since 0.1.0). It runs anywhere Lodash 4.x runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash.
Available in [email protected] full builds and the lodash/isEqual modular import. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Safe for production once Lodash is loaded. Prefer import isEqual from "lodash/isEqual" for smaller builds. Use isEqualWith when you need custom field rules.
Customize deep equality with a customizer callback.
11 people found this page helpful