assert.closeTo()

version added: 2.21.0.

Description

closeTo( actual, expected, delta, message = "" )

Compare that a number is equal to a known target number within a given tolerance.

The assert.closeTo() assertion checks that the actual expression approximates the expected number, allowing it to be off by at most the specified amount (“delta”). This can be used to assert that two numbers are roughly or almost equal to each other.

The actual number may be either above or below the expected number, as long as it is within the delta difference (inclusive).

While non-strict assertions like this are often discouraged, it may be necessary to account for limitations in how fractional numbers are represented in JavaScript. For example, 0.1 + 0.2 is actually 0.30000000000000004. This because math operations in JavaScript adhere to the “IEEE floating-point” standard.

To learn how floating-point numbers work internally, refer to Double-precision floating-point format on Wikipedia. To learn when and why floating-point numbers experience these side effects, refer to “What Every Computer Scientist Should Know About Floating-Point Arithmetic” by David Goldberg.

Examples

QUnit.test('good example', assert => {
  const x = 0.1 + 0.2; // 0.30000000000000004

  // passing: must be between 0.299 and 0.301
  assert.closeTo(x, 0.3, 0.001);

  const y = 20.13;
  // passing: must be between 20.05 and 20.15 inclusive
  assert.closeTo(y, 20.10, 0.05);
});

QUnit.test('bad example', assert => {
  const x = 20.7;
  // failing: must be between 20.0 and 20.2 inclusive
  assert.closeTo(x, 20.1, 0.1);
  // message: value should be within 0.1 inclusive
  // actual  : 20.7
  // expected: 20.1

  const y = 2018;
  // failing: must be between 2010 and 2014 inclusive
  assert.closeTo(y, 2012, 2);
  // message: value should be within 2 inclusive
  // actual  : 2018
  // expected: 2012
});

See also

• Use assert.propContains() to partially compare an object.