@technobuddha/library
Version:
A large library of useful functions
20 lines • 995 B
JavaScript
/**
* Clamps a number within the inclusive range specified by `min` and `max`.
* @param value - The number to clamp.
* @param min - The lower bound of the range.
* @param max - The upper bound of the range.
* @returns The clamped value, which will be no less than `min` and no greater than `max`.
* @example
* ```typescript
* clamp(5, 1, 10); // 5
* clamp(-2, 0, 7); // 0
* clamp(15, 0, 10); // 10
* clamp(3, 3, 3); // 3
* ```
* @group Math
* @category Operations
*/
export function clamp(value, min, max) {
return Math.min(Math.max(value, min), max);
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhbXAuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY2xhbXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7Ozs7Ozs7Ozs7OztHQWVHO0FBQ0gsTUFBTSxVQUFVLEtBQUssQ0FBQyxLQUFhLEVBQUUsR0FBVyxFQUFFLEdBQVc7SUFDM0QsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsS0FBSyxFQUFFLEdBQUcsQ0FBQyxFQUFFLEdBQUcsQ0FBQyxDQUFDO0FBQzdDLENBQUMifQ==