@modern-kit/utils/dist/number/clamp/index.d.ts

modern-kit/utils

/**
 * @description 주어진 값을 `최댓값`으로 제한합니다.
 *
 * @param {number} value - 제한할 숫자
 * @param {number} max - 최대 범위
 * @returns {number} 지정된 범위 내로 제한된 숫자
 *
 * @example
 * clamp(3, 5); // 3
 * clamp(10, 6); // 6
 */
declare function clamp(value: number, max: number): number;
/**
 * @description 주어진 값을 `최솟값`과 `최댓값` 사이로 제한합니다.
 *
 * @param {number} value - 제한할 숫자
 * @param {number} min - 최소 범위
 * @param {number} max - 최대 범위
 * @returns {number} 지정된 범위 내로 제한된 숫자
 *
 * @example
 * clamp(7, 0, 10); // 7
 * clamp(10, 0, 5); // 5
 * clamp(-5, 0, 10); // 0
 */
declare function clamp(value: number, min: number, max: number): number;

export { clamp };