@augment-vir/common/dist/augments/number/clamp.d.ts

A collection of augments, helpers types, functions, and classes for any JavaScript environment.

import { type MinMax } from '@augment-vir/core';
/**
 * Clamp's the given value to within the min and max bounds, inclusive.
 *
 * @category Number
 * @category Package : @augment-vir/common
 * @example
 *
 * ```ts
 * import {clamp} from '@augment-vir/common';
 *
 * // `result` will be `40`
 * const result = clamp(42, {min: 30, max: 40});
 * ```
 *
 * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
 */
export declare function clamp(value: number, { min, max }: Readonly<MinMax>): number;