Assert module for assertions in Node.js

Introduction

The Assert module helps check if your code works as expected by testing values. It stops your program if something is wrong.

When you want to test if a function returns the right result.

When you want to check if two values are equal during development.

When you want to catch errors early by verifying conditions.

When writing simple tests without extra tools.

When debugging to confirm assumptions in your code.

Syntax

Node.js

import assert from 'assert';

assert.strictEqual(actual, expected, 'optional error message');

Use strictEqual to check if two values are exactly the same.

If the assertion fails, the program throws an error and stops.

Examples

This checks if 5 equals 5. It passes silently because they are equal.

Node.js

import assert from 'assert';

assert.strictEqual(5, 5);

This throws an error with the message 'Strings do not match' because the strings differ.

Node.js

import assert from 'assert';

assert.strictEqual('hello', 'world', 'Strings do not match');

assert.ok checks if the value is truthy. Here it passes because true is truthy.

Node.js

import assert from 'assert';

assert.ok(true, 'This should not fail');

Sample Program

This program defines a simple add function. It uses assert.strictEqual to check if adding 2 and 3 equals 5. If the check passes, it prints 'Test passed!'. If it fails, it stops with an error.

Node.js

import assert from 'assert';

function add(a, b) {
  return a + b;
}

const result = add(2, 3);
assert.strictEqual(result, 5, 'Addition result should be 5');
console.log('Test passed!');

Important Notes

Assertions help catch bugs early by verifying your code behaves as expected.

Use clear messages in assertions to understand failures quickly.

Assertions are mainly for development and testing, not for handling user errors.

Summary

The Assert module checks if values meet conditions and stops code if not.

Use it to test your code during development simply and quickly.

It helps find mistakes early before your program runs fully.

Practice

1. What is the main purpose of the assert module in Node.js?

easy

A. To check if values meet expected conditions and throw errors if not

B. To handle HTTP requests and responses

C. To manage file system operations

D. To create and manage database connections

Solution

1. Step 1: Understand the role of the assert module

   The assert module is designed to verify conditions in code and throw errors when conditions fail.

2. Step 2: Compare with other options

   Options B, C, and D relate to other Node.js modules like http, fs, and database libraries, not assert.

3. Final Answer:

   To check if values meet expected conditions and throw errors if not -> Option A

4. Quick Check:

   assert module = condition checks [OK]

Hint: Assert checks conditions and stops code if false [OK]

Common Mistakes:

• Confusing assert with modules for HTTP or file operations
• Thinking assert manages asynchronous events
• Assuming assert modifies data instead of checking it

2. Which of the following is the correct way to import the assert module in Node.js?

easy

A. const assert = require('assert');

B. import assert from 'assert';

C. const assert = import('assert');

D. require assert from 'assert';

Solution

1. Step 1: Recall Node.js CommonJS import syntax

   Node.js traditionally uses const module = require('module') to import modules.

2. Step 2: Check each option

   const assert = require('assert'); uses correct CommonJS syntax. import assert from 'assert'; is ES module syntax, which requires special setup. Options A and C are invalid syntax.

3. Final Answer:

   const assert = require('assert'); -> Option A

4. Quick Check:

   CommonJS import = require() [OK]

Hint: Use require() to import assert in Node.js [OK]

Common Mistakes:

• Using ES module import without enabling it
• Mixing import and require syntax
• Writing invalid require statements

3. What will be the output of the following code snippet?

const assert = require('assert');
assert.strictEqual(5, '5');
console.log('Test passed');

medium

A. Test passed

B. TypeError: Cannot compare number and string

C. No output, program crashes silently

D. AssertionError: Expected values to be strictly equal

Solution

1. Step 1: Understand assert.strictEqual behavior

   assert.strictEqual checks if two values are strictly equal (===). Number 5 and string '5' are not strictly equal.

2. Step 2: Predict the result

   Since the values differ in type, assert.strictEqual throws an AssertionError and stops execution before console.log.

3. Final Answer:

   AssertionError: Expected values to be strictly equal -> Option D

4. Quick Check:

   strictEqual fails if types differ [OK]

Hint: strictEqual needs same type and value [OK]

Common Mistakes:

• Thinking '5' and 5 are equal with strictEqual
• Expecting console.log to run after failed assert
• Confusing strictEqual with loose equality

4. Identify the error in the following code using the assert module:

const assert = require('assert');
assert.equal(10, 10);
assert.equal(5, '5');
assert.strictEqual(3, 3);
assert.strictEqual(4, '4');

medium

A. assert.equal(5, '5') will throw an error

B. assert.strictEqual(4, '4') will throw an error

C. assert.equal(10, 10) will throw an error

D. No errors in the code

Solution

1. Step 1: Review assert.equal vs assert.strictEqual

   assert.equal uses loose equality (==), so 5 and '5' are equal. assert.strictEqual uses strict equality (===), so 4 and '4' differ in type.

2. Step 2: Identify which assertion fails

   assert.strictEqual(4, '4') fails and throws an AssertionError. Others pass without error.

3. Final Answer:

   assert.strictEqual(4, '4') will throw an error -> Option B

4. Quick Check:

   strictEqual fails on type mismatch [OK]

Hint: strictEqual fails if types differ, equal allows type coercion [OK]

Common Mistakes:

• Assuming assert.equal throws error on 5 and '5'
• Thinking assert.strictEqual allows type coercion
• Ignoring that assert.equal passes with loose equality

5. You want to verify that a function getUserName() returns a non-empty string. Which assert statement correctly checks this condition?

hard

A. assert.strictEqual(typeof getUserName(), 'string'); assert.ok(getUserName().length > 0);

B. assert.equal(getUserName(), 'string'); assert.ok(getUserName() !== '');

C. assert.ok(typeof getUserName() === 'string' && getUserName().length > 0);

D. assert.strictEqual(getUserName().length, 'string');

Solution

1. Step 1: Understand the condition to check

   The function must return a string type and the string must not be empty (length > 0).

2. Step 2: Evaluate each option

   assert.strictEqual(typeof getUserName(), 'string'); assert.ok(getUserName().length > 0); calls getUserName() twice, which may differ and is less efficient. assert.equal(getUserName(), 'string'); assert.ok(getUserName() !== ''); incorrectly compares value to string 'string'. assert.strictEqual(getUserName().length, 'string'); compares length to string 'string', which is invalid. assert.ok(typeof getUserName() === 'string' && getUserName().length > 0); correctly checks both conditions in one assert.ok call.

3. Final Answer:

   assert.ok(typeof getUserName() === 'string' && getUserName().length > 0); -> Option C

4. Quick Check:

   Use assert.ok with combined condition [OK]

Hint: Combine type and length check in one assert.ok [OK]

Common Mistakes:

• Comparing value to string 'string' instead of typeof
• Calling function multiple times causing inconsistent results
• Comparing length to a string instead of a number