Introduction

The assert_nearly_equal package asserts that a given numerical expected value and actual value are approximately equal.

Installation

This package should be installed via npm. You must have npm installed first. The following can be run on the commandline to install the assert_nearly_equal package with npm:

npm install @nicolawealth/assest_nearly_equal

Usage

This package should be used for asserting or comparing floating point values which need not be exactly equal due to differences caused by rounding or truncating, but ensuring they are nearly equal (within an acceptable error bound).

Interface

The package exports one function assertNearlyEqual(actual, expected, errorMsg, epsilon) where actual and expected are the two values to be compared. errorMsg is the string message which will be displayed if the assert fails. epsilon is the (inclusive) upperbound on the difference between the actual and expected values and is defaulted to 0.000001 if not specified.

Testing

Tests can be found in assest_nearly_equal.test.ts located in asset_nearly_equal/src and should be run with sinon, mocha and nyc.