is-roughly-equal ❓
Check if a number is within a certain fault tolerance to another. Supports currying.
is-roughly-equal is ISC-licensed and tested well.
Installing
npm install is-roughly-equal
Usage
const isRoughlyEqual = require 'is-roughly-equal' // without currying // false // true // true // true // false const check = // equal to 10 with tolerance of 1 // false // true // true // true // false
API
isRoughlyEqual([tolerance], [a], [b])
- Called without arguments, returns
isRoughlyEqual.unary(1)
. - Called with 1 arguments
tolerance
, returnsisRoughlyEqual.unary(tolerance)
- Called with 2 arguments
tolerance
anda
, returnsisRoughlyEqual.binary(tolerance, a)
. - Called with 3 arguments
tolerance
,a
andb
, returnsisRoughlyEqual.ternary(tolerance, a, b)
.
isRoughlyEqual.unary(tolerance)
Returns a function (a, b) => isRoughlyEqual.ternary(tolerance, a, b)
.
isRoughlyEqual.binary(tolerance, a)
Returns a function (b) => isRoughlyEqual.ternary(tolerance, a, b)
.
isRoughlyEqual.ternary(tolerance, a, b)
Returns true
of false
. Checks if a
is within a distance of tolerance
to b
.
Contributing
If you have a question, found a bug or want to propose a feature, have a look at the issues page.