Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

clamp

import { clamp } from "https://raw.githubusercontent.com/JOTSR/Denum/master/mod.ts";

Clamp a value between min and max

function clamp(
value: number,
min: number,
max: number,
): number;
function clamp(
value: bigint,
min: bigint,
max: bigint,
): bigint;
function clamp<T extends number | bigint>(
value: T,
min: T,
max: T,
): T;
§
clamp(value: number, min: number, max: number): number
[src]

Clamp a value between min and max

§Parameters

§
value: number
[src]

Value to be bounded

§
min: number
[src]

Lower bound

§
max: number
[src]

Upper bound

§Return Type

§
number
[src]

Clamped value

§
clamp(value: bigint, min: bigint, max: bigint): bigint
[src]

Clamp a value between min and max

§Parameters

§
value: bigint
[src]

Value to be bounded

§
min: bigint
[src]

Lower bound

§
max: bigint
[src]

Upper bound

§Return Type

§
bigint
[src]

Clamped value

§
clamp<T extends number | bigint>(value: T, min: T, max: T): T
[src]

§Type Parameters

§
T extends number | bigint
[src]

§Parameters

§
value: T
[src]
§
min: T
[src]
§
max: T
[src]

§Return Type