Math.min()
The static function Math.min()
returns the lowest-valued number passed into it, or NaN
if any parameter
isn't a number and can't be converted into one.
Try it
Syntax
Math.min()
Math.min(value0)
Math.min(value0, value1)
Math.min(value0, value1, ... , valueN)
Parameters
value1, value2, ...
-
Zero or more numbers among which the lowest value will be selected and returned.
Return value
Description
Examples
Using Math.min()
This finds the min of x
and y
and assigns it to
z
:
const x = 10, y = -20;
const z = Math.min(x, y);
Clipping a value with Math.min()
Math.min()
is often used to clip a value so that it is always less than or
equal to a boundary. For instance, this
let x = f(foo);
if (x > boundary) {
x = boundary;
}
may be written as this
const x = Math.min(f(foo), boundary);
Math.max()
can be used in a similar way to clip a value at the other end.
Specifications
Specification |
---|
ECMAScript Language Specification # sec-math.min |
Browser compatibility
BCD tables only load in the browser