Assert.prototype.closeTo - default - QUnitX documentation

method Assert.prototype.closeTo



Assert.prototype.closeTo(actual: number,
expected: number,
delta: number,
message?: string
): void

Asserts that actual is within delta of expected, inclusive: for numbers that floating-point arithmetic makes almost, but not exactly, equal.

Examples

test("floating point", (assert) => {
  assert.closeTo(0.1 + 0.2, 0.3, 0.001);
  assert.closeTo(Math.PI, 3.141, 0.001);
});



actual: number

The value produced by the code under test.



expected: number

The value it should be close to.



delta: number

The largest allowed difference.

optional



message: string

Optional failure message.

void

TypeError

If delta is not a number.