closeTo

Bun

Symbol

AsymmetricMatchersBuiltin.closeTo

closeTo(num: number, numDigits?: number): any

Useful when comparing floating point numbers in object properties or array item. If you need to compare a number, use .toBeCloseTo instead.

The optional numDigits argument limits the number of digits to check after the decimal point. For the default value 2, the test criterion is Math.abs(expected - received) < 0.005 (that is, 10 ** -2 / 2).