clamp

Clamps a number between min and max values

Available since v1.9.0

Import

import { clamp } from '@helpers4/number';
// or, from the all-in-one package (same code, one install):
import { clamp } from 'helpers4/number';

Signature

clamp(value: number, min: number, max: number): number

Parameters

Parameter	Type	Description
value	number	The value to clamp
min	number	Minimum value
max	number	Maximum value

Returns

number — Clamped value

Examples

Clamp a value within range

Restricts a number to be within a min/max range.

clamp(15, 0, 10)  // => 10
clamp(-5, 0, 10)  // => 0
clamp(5, 0, 10)   // => 5

Source

View source on GitHub