requireNumber()function
requireNumber(value: PossibleNumber, min?: number, max?: number, caller?: AnyCaller): number
| Param | Type | |
|---|---|---|
value | PossibleNumber | The value to convert. 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. |
| Return | |
|---|---|
number | The finite number. |
| Throws | |
|---|---|
unknown | RequiredError if value cannot be converted to a finite number within range. |
Convert a possible number to a finite number, or throw ValueError if the value cannot be converted.
Examples
requireNumber("42") // 42