math-clamp-x

Clamp a number to limits.

Usage no npm install needed!

<script type="module">
  import mathClampX from 'https://cdn.skypack.dev/math-clamp-x';
</script>

README

Travis status Dependency status devDependency status npm version jsDelivr hits bettercodehub score Coverage Status

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:

  • RangeError If 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