Licence
MIT
Version
3.2.2
Deps
1
Size
226 kB
Vulns
0
Weekly
0
math-clamp-x
Clamp a number to limits.
module.exports(value, [min], max) ⇒ number
This method clamp a number to min and max limits inclusive.
Kind: Exported function
Returns: number - The clamped number.
Throws:
RangeErrorIf min > max.
| Param | Type | Default | Description |
|---|---|---|---|
| value | number |
The number to be clamped. | |
| [min] | number |
0 |
The minimum number. |
| max | number |
The maximum number. |
Example
import mathClamp from 'math-clamp-x';
console.log(mathClamp(-5, 3, 3)); // 3
console.log(mathClamp(0, 3, 3)); // 3
console.log(mathClamp(5, 3, 3)); // 3