Skip to main content
default.equal - node__assert.d.ts - Node documentation
function default.equal

Usage in Deno

```typescript import mod from "node:node__assert.d.ts"; ```
equal(
actual: unknown,
expected: unknown,
message?: string | Error,
): void
**Strict assertion mode** An alias of [strictEqual](../.././node__assert.d.ts/~/default.strictEqual). **Legacy assertion mode** > Stability: 3 - Legacy: Use [strictEqual](../.././node__assert.d.ts/~/default.strictEqual) instead. Tests shallow, coercive equality between the `actual` and `expected` parameters using the [`==` operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Equality). `NaN` is specially handled and treated as being identical if both sides are `NaN`. ```js 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

actual: unknown
expected: unknown
optional
message: string | Error

Return Type

void