33 lines
1.4 KiB
TypeScript
33 lines
1.4 KiB
TypeScript
/**
|
|
* Clamps a number within the inclusive upper bound.
|
|
*
|
|
* This function takes a number and a maximum bound, and returns the number clamped within the specified upper bound.
|
|
* If only one bound is provided, it returns the minimum of the value and the bound.
|
|
*
|
|
* @param {number} value - The number to clamp.
|
|
* @param {number} maximum - The maximum bound to clamp the number.
|
|
* @returns {number} The clamped number within the specified upper bound.
|
|
*
|
|
* @example
|
|
* const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
|
|
*/
|
|
declare function clamp(value: number, maximum: number): number;
|
|
/**
|
|
* Clamps a number within the inclusive lower and upper bounds.
|
|
*
|
|
* This function takes a number and two bounds, and returns the number clamped within the specified bounds.
|
|
*
|
|
* @param {number} value - The number to clamp.
|
|
* @param {number} minimum - The minimum bound to clamp the number.
|
|
* @param {number} maximum - The maximum bound to clamp the number.
|
|
* @returns {number} The clamped number within the specified bounds.
|
|
*
|
|
* @example
|
|
* const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15
|
|
* const result3 = clamp(2, 5, 15); // result3 will be 5, as 2 is clamped to the lower bound 5
|
|
* const result4 = clamp(20, 5, 15); // result4 will be 15, as 20 is clamped to the upper bound 15
|
|
*/
|
|
declare function clamp(value: number, minimum: number, maximum: number): number;
|
|
|
|
export { clamp };
|