Interface CloseToFn<R>

This interface provides methods for checking if the current actual value is close to an expected value within a specified delta (tolerance).

Since

0.1.5

Type Parameters

R
The type of the result of the operation.

CloseToFn(expected: number, delta: number, evalMsg?: MsgSource): R
Asserts that the value is close to the expected value within the specified delta.
Parameters
- expected: number
  The expected value to compare against
- delta: number
  The maximum allowed difference between actual and expected. Note: A negative delta will never result in a passing assertion since the absolute difference is always non-negative.
- OptionalevalMsg: MsgSource
  The message to evaluate if the assertion fails
Returns R
The result of the operation, which will generally be the existing IAssertScope.that object.

Throws
An AssertionFailure if the assertion fails
- Defined in assert/interface/funcs/CloseToFn.ts:28