is-roughly-equal v0.1.0

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
isRoughlyEqual(11.1) // false
isRoughlyEqual(11)   // true
isRoughlyEqual(10)   // true
isRoughlyEqual(9)    // true
isRoughlyEqual(8.9)  // false

const check = isRoughlyEqual(1, 10) // equal to 10 with tolerance of 1
check(11.1) // false
check(11)   // true
check(10)   // true
check(9)    // true
check(8.9)  // false

API

isRoughlyEqual([tolerance], [a], [b])

• Called without arguments, returns isRoughlyEqual.unary(1).
• Called with 1 arguments tolerance, returns isRoughlyEqual.unary(tolerance)
• Called with 2 arguments tolerance and a, returns isRoughlyEqual.binary(tolerance, a).
• Called with 3 arguments tolerance, a and b, returns isRoughlyEqual.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.