Interface WithinFn<R>

This interface provides methods checking in the current actual value is within the provided start and end range.

Type Parameters

R
The type of the result of the operation.

WithinFn(start: number, finish: number, evalMsg?: MsgSource): R
Asserts that the value is within the specified range.
Parameters
- start: number
  The start of the range
- finish: number
  The end of the range
- OptionalevalMsg: MsgSource
  The message to evaluate
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/WithinFn.ts:27
WithinFn(start: Date, finish: Date, evalMsg?: MsgSource): R
Asserts that the value is within the specified range.
Parameters
- start: Date
  The start of the range
- finish: Date
  The end of the range
- OptionalevalMsg: MsgSource
  The message to evaluate
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/WithinFn.ts:38