random source npm

_.random([min=0], [max=1], [floating])

Produces a random number between min and max (inclusive). If only one argument is provided a number between 0 and the given number is returned. If floating is true, or either min or max 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.

Arguments

  1. [min=0] (number)

    The minimum possible value.

  2. [max=1] (number)

    The maximum possible value.

  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