assert
Advanced tools
Package description
The assert npm package is a module that provides a set of assertion functions for verifying invariants. It is primarily used for writing tests to ensure that code behaves as expected. The module includes functions to test strict equality, deep equality, and various other conditions.
Strict Equality Assertion
This feature is used to test if two values are strictly equal using the === operator.
const assert = require('assert');
assert.strictEqual(1, 1, '1 is strictly equal to 1');Deep Equality Assertion
This feature is used to test if two objects or arrays are equal by comparing their properties or elements.
const assert = require('assert');
assert.deepStrictEqual({ a: 1 }, { a: 1 }, 'Objects are deeply equal');Assertion with a Predicate Function
This feature is used to test if a value passes a specified predicate function.
const assert = require('assert');
assert.ok(value => value > 10, 'Value is greater than 10');Throws Assertion
This feature is used to test if a function throws an error as expected.
const assert = require('assert');
assert.throws(
() => { throw new Error('Wrong value'); },
Error,
'Function should throw an Error'
);Chai is a BDD/TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework. It offers more plugins and a more flexible API compared to assert.
Expect is a minimalistic assertion library that provides a set of assertion functions and is often used with Jest. It offers a more fluent and readable syntax compared to assert.
Should.js is an expressive, readable, framework-agnostic assertion library. It extends the Object prototype with a single non-enumerable getter that allows for a more fluent and chainable API, providing a different style of coding compared to assert.
Readme
This module is used for writing unit tests for your applications, you can access it with require('assert').
The API is derived from the commonjs 1.0 unit testing spec and the node.js assert module
Throws an exception that displays the values for actual and expected separated by the provided operator.
Tests if value is truthy, it is equivalent to assert.equal(true, !!value, message);
Tests shallow, coercive equality with the equal comparison operator ( == ).
Tests shallow, coercive non-equality with the not equal comparison operator ( != ).
Tests for deep equality.
Tests for any deep inequality.
Tests strict equality, as determined by the strict equality operator ( === )
Tests strict non-equality, as determined by the strict not equal operator ( !== )
Expects block to throw an error. error can be constructor, regexp or validation function.
Validate instanceof using constructor:
assert.throws(function() { throw new Error("Wrong value"); }, Error);
Validate error message using RegExp:
assert.throws(function() { throw new Error("Wrong value"); }, /value/);
Custom error validation:
assert.throws(function() {
throw new Error("Wrong value");
}, function(err) {
if ( (err instanceof Error) && /value/.test(err) ) {
return true;
}
}, "unexpected error");
Expects block not to throw an error, see assert.throws for details.
Tests if value is not a false value, throws if it is a true value. Useful when testing the first argument, error in callbacks.
FAQs
The assert module from Node.js, for the browser.
The npm package assert receives a total of 11,221,664 weekly downloads. As such, assert popularity was classified as popular.
We found that assert demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.