clamp

number

Clamps a number between a lower and upper bound.

Installation

Import

import { clamp } from '@tulx/utils';

Source Code

Implementation

/**
 * Clamps a number between a lower and upper bound.
 *
 * @param number - The number to clamp.
 * @param lower - The lower bound.
 * @param upper - The upper bound.
 * @returns The clamped number.
 *
 * @example
 * ```ts
 * clamp(-10, -5, 5); // -5
 * clamp(10, -5, 5); // 5
 * clamp(3, -5, 5); // 3
 * ```
 */
export function clamp(number: number, lower: number, upper: number): number {
  if (number < lower) {
    return lower;
  }
  if (number > upper) {
    return upper;
  }
  return number;
}

Example

import { clamp } from '@tulx/utils';

clamp(-10, -5, 5); // -5
clamp(10, -5, 5); // 5
clamp(3, -5, 5); // 3

Related Functions

inRange

Checks if a number is between start and up to, but not including, end. If end is not specified, it's set to start with start then 0.

random

Produces a random number between the inclusive lower and upper bounds. If only one argument is provided, a number between 0 and the given number is returned. If floating is true, or either lower or upper are floats, a floating-point number is returned instead of an integer.