Skip to main content

equal

function assert.equal
Jump to headingequal(
actual: unknown,
expected: unknown,
message?: string | Error,
): void

Strict assertion mode

An alias of strictEqual.

Legacy assertion mode

Stability: 3 - Legacy: Use strictEqual instead.

Tests shallow, coercive equality between the actual and expected parameters using the == operator. NaN is specially handled and treated as being identical if both sides are NaN.

import assert from 'node:assert';

assert.equal(1, 1);
// OK, 1 == 1
assert.equal(1, '1');
// OK, 1 == '1'
assert.equal(NaN, NaN);
// OK

assert.equal(1, 2);
// AssertionError: 1 == 2
assert.equal({ a: { b: 1 } }, { a: { b: 1 } });
// AssertionError: { a: { b: 1 } } == { a: { b: 1 } }

If the values are not equal, an AssertionError is thrown with a message property set equal to the value of the message parameter. If the message parameter is undefined, a default error message is assigned. If the message parameter is an instance of an Error then it will be thrown instead of the AssertionError.

Parameters Jump to heading

Jump to headingactual: unknown
Jump to headingexpected: unknown
optional
Jump to headingmessage: string | Error

Return Type Jump to heading

void
Back to top