ut2/types/clamp.d.ts

一个现代 JavaScript 实用工具库。[点击查看在线文档]。

interface Clamp {
    (number: number, upper: number): number;
    (number: number, lower: number, upper: number): number;
}
/**
 * 数字限制在 `lower` 和 `upper` 之间的值。
 *
 * 特殊说明：
 * - 如果只传入 1 个参数，直接返回该参数；
 * - 如果只传入 2 个参数，`lower` 透传给 `upper`。
 *
 * @function
 * @alias module:Number.clamp
 * @since 1.0.0
 * @param {number} number 被限制的值。
 * @param {number} [lower] 下限。
 * @param {number} upper 上限。
 * @returns {number} 限制后的值。
 * @example
 *
 * clamp(-10, -5, 5); // -5
 *
 * clamp(-10, 0, 5); // 0
 *
 * clamp(10, -5, 5); // 5
 *
 * // 仅限制上限
 * clamp(10, 5); // 5
 *
 * clamp(-10, 5); // -10
 *
 */
declare const clamp: Clamp;
export default clamp;