Math.min()

The Math.min() function returns the smallest of zero or more numbers.

Syntax

Math.min([<var>value1</var>[, <var>value2</var>[, ...]]])

Parameters

value1, value2, ...

Numbers.

Return value

The smallest of the given numbers. If at least one of the arguments cannot be converted to a number, NaN is returned.

Description

Because min() is a static method of Math, you always use it as Math.min(), rather than as a method of a Math object you created (Math is not a constructor).

If no arguments are given, the result is Infinity.

If at least one of arguments cannot be converted to a number, the result is NaN.

Examples

Using Math.min()

This finds the min of x and y and assigns it to z:

var x = 10, y = -20;
var 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

var x = f(foo);

if (x > boundary) {
  x = boundary;
}

may be written as this

var x = Math.min(f(foo), boundary);

Math.max() can be used in a similar way to clip a value at the other end.

Specifications

Browser compatibility

See also

• Math.max()