_.clamp(number, [lower], upper)

Clamps number within the inclusive lower and upper bounds.

Since

4.0.0

Arguments

1. number (number): The number to clamp.
2. [lower] (number): The lower bound.
3. upper (number): The upper bound.

Returns

(number): Returns the clamped number.

Example

_.clamp(-10, -5, 5);
// => -5
_.clamp(10, -5, 5);
// => 5

_.inRange(number, [start=0], end)

Checks if n is between start and up to, but not including, end. If end is not specified, it’s set to start with start then set to 0. If start is greater than end the params are swapped to support negative ranges.

Since

3.3.0

Arguments

1. number (number): The number to check.
2. [start=0] (number): The start of the range.
3. end (number): The end of the range.

Returns

(boolean): Returns true if number is in the range, else false.

Example

_.inRange(3, 2, 4);
// => true
_.inRange(4, 8);
// => true
_.inRange(4, 2);
// => false
_.inRange(2, 2);
// => false
_.inRange(1.2, 2);
// => true
_.inRange(5.2, 4);
// => false
_.inRange(-3, -2, -6);
// => true

_.random([lower=0], [upper=1], [floating])

Produces a random number between the inclusive lower and upper bounds. If only one argument is provided a number between 0 and the given number is returned. If floating is true, or either lower or upper are floats, a floating-point number is returned instead of an integer.

Note: JavaScript follows the IEEE-754 standard for resolving floating-point values which can produce unexpected results.

Since

0.7.0

Arguments

1. [lower=0] (number): The lower bound.
2. [upper=1] (number): The upper bound.
3. [floating] (boolean): Specify returning a floating-point number.

Returns

(number): Returns the random number.

Example

_.random(0, 5);
// => an integer between 0 and 5
_.random(5);
// => also an integer between 0 and 5
_.random(5, true);
// => a floating-point number between 0 and 5
_.random(1.2, 5.2);
// => a floating-point number between 1.2 and 5.2