clamp

주어진 숫자 값을 지정된 범위로 제한하는 함수입니다.

Signatures

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

Parameters

이름	타입	설명	필수 여부
value	`number`	제한하고자 하는 값	✓
min	`number`	최소 범위 (두 번째 인자로 사용 시 최대 범위)	✓
max	`number`	최대 범위	-

Returns

number - 지정된 범위 내로 제한된 숫자

사용 예시

최댓값만 지정하는 경우

import { clamp } from '@teamsparta/utils';
 
clamp(3, 5); // 3  (3은 5보다 작으므로 그대로 반환)
clamp(10, 6); // 6  (10은 6보다 크므로 6으로 제한)

최솟값과 최댓값을 모두 지정하는 경우

import { clamp } from '@teamsparta/utils';
 
clamp(7, 0, 10); // 7   (범위 내 값은 그대로 반환)
clamp(10, 0, 5); // 5   (최댓값으로 제한)
clamp(-5, 0, 10); // 0   (최솟값으로 제한)

noop random