chai-bigint

chai-bigint

Chai assertions for comparing arbitrary-precision integers using the bigint native type. Adapted from ethereum-waffle.

Installation

yarn add chai-bigint --dev

OR

npm install chai-bigint --save-dev

Usage

const chai = require('chai');

chai.use(require('chai-bigint'));

Assertions

The following assertion methods are provided and will override the existing builtin assertions if the bigint property is set as part of the assertion chain:

• equal/equals/eq
• above/gt/greaterThan
• least/gte
• below/lt/lessThan
• most/lte
• closeTo

A set of additional assertion properties is also provided:

• negative
• zero

Both actual values (the values being asserted) and expected values (the values the actual value is expected to match) can be either instances of bigint, or strings which can be converted into a valid number.

Only BDD style (expect or should) assertions are supported.

Examples

Methods:

const actual = 100000000000000000n + 1n;
const expected = 100000000000000001n;

expect(actual).to.be.equal(expected);
expect(actual).to.be.gt(100n);

License

chai-bn is open source and distributed under the MIT License (see LICENSE).