assertNumber()function
assertNumber(value: unknown, min?: number, max?: number, caller: AnyCaller = assertNumber): asserts value is number
| Param | Type | |
|---|---|---|
value | unknown | The value to assert. required |
min | number | Minimum allowed value, inclusive. |
max | number | Maximum allowed value, inclusive. |
caller | AnyCaller | Function used to attribute a thrown error to the calling site. Defaults to assertNumber |
| Return | |
|---|---|
asserts value is number | Nothing; narrows value to number. |
| Throws | |
|---|---|
unknown | RequiredError if value is not a finite number within range. |
Assert that a value is a finite number (optionally within a specified min/max range).
Examples
assertNumber(5, 0, 10); // passes