@newdash/newdash/clamp.d.ts

javascript/typescript utility library

/**
 * Clamps `number` within the inclusive `lower` and `upper` bounds.
 *
 * @since 5.7.0
 * @category Number
 * @param  num The number to clamp.
 * @param lower The lower bound.
 * @param upper The upper bound.
 * @returns Returns the clamped number.
 * @example
 *
 * ```js
 * clamp(-10, -5, 5)
 * // => -5
 *
 * clamp(10, -5, 5)
 * // => 5
 * ```
 */
export declare function clamp(num: number, lower?: number, upper?: number): number;
export default clamp;