Node.js assert.equal() Function

Last Updated : 21 Mar, 2023

The assert module provides a set of assertion functions for verifying invariants. The assert.equal() function tests for equality between the actual and the expected parameters. If the condition is true it will not produce an output else an assertion error is raised.

Syntax:

assert.equal(actual, expected[, message])

Parameters: This function accepts the following parameters as mentioned above and described below:

actual: This parameter holds the actual value that needs to be evaluated. It is of any type.
expected: This parameter holds the expected value which is matched against the actual value. It is of any type.
message: This parameter holds the error message of string or error type. It is an optional parameter.

Return Value: This function returns an assertion error of object type.

Installation of assert module:

You can visit the link to Install the assert module. You can install this package by using this command.

npm install assert

Note: Installation is an optional step as it is an inbuilt Node.js module.

After installing the assert module, you can check your assert version in the command prompt using the command.

npm version assert

Project Structure:

After that, you can just create a folder and add a file, for example, index.js as shown below.

Example 1: Filename: index.js

javascript

// Requiring the module
const assert = require('assert').strict;

let a = 10;
let b = 20;

// Function call
try {
    assert.equal(a, b);
} catch (error) {
    console.log(& quot; Error: & quot;, error)
}

Steps to run the program:

Run the index.js file using the below command:

node index.js

Output:

Error: AssertionError [ERR_ASSERTION]: Expected values to be strictly equal: 10 !== 20 at Object. (C:\Users\Lenovo\Downloads\index.js:17:12) at Module._compile (internal/modules/cjs/loader.js:1138:30) at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10) at Module.load (internal/modules/cjs/loader.js:986:32) at Function.Module._load (internal/modules/cjs/loader.js:879:14) at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12) at internal/main/run_main_module.js:17:47 { generatedMessage: true, code: 'ERR_ASSERTION', actual: 10, expected: 20, operator: 'strictEqual' }

Example 2: Filename: index.js

javascript

// Requiring the module
const assert = require('assert').strict;

let a = 20;
let b = 20;

// Function call
try {
    assert.equal(a, b);
    console.log("No Error Occurred")
} catch (error) {
    console.log(" Error:", error)
}