Node.js assert.deepEqual() Method
Example
If two objects, or their child objects, are not equal, an error is thrown and the program is terminated:
var assert = require('assert');
var x = { a : { n: 0 } };
var y = { a :
{ n: 0 } };
var z = { a : { n: 1 } };
assert.deepEqual(x, y); //OK
assert.deepEqual(x,
z); /*AssertionError: { a: { n: 0 } } deepEqual {a: { n: 1 } }*/
Run example »
Definition and Usage
The assert.deepEqual() method tests if two objects, and their child objects, are equal, using the == operator.
If the two objects are not equal, an assertion failure is being caused, and the program is terminated.
To compare the objects using the === operator, use the assert.deepStrictEqual() method.
Syntax
assert.deepEqual(value1, value2, message);
Parameter Values
Parameter | Description |
---|---|
value1 | Required. Specifies the first value to be compared |
value2 | Required. Specifies the second value to be compared |
message | Optional. Specifies the error message to be assigned to the AssertionError. If omitted, a default message is assigned |
Technical Details
Return Value: | None |
---|---|
Node.js Version: | 0.1.21 |
More Examples
Example
Using the message parameter:
var assert = require('assert');
var x = { a : { n: 0 } };
var z = { a :
{ n: 1 } };
assert.deepEqual(x, z, "My message goes here");
Run example »