random-integral v1.0.3

random-integral

Return a random integer.

Install

$ npm install --save random-integral

Usage

For more use-cases see the tests

var randomInt = require('random-integral');

// API
// - randomInt([options])

By default it will return an integer between -9007199254740992 and 9007199254740992:

randomInt();
// => -1293235

Can optionally provide min and max:

randomInt({ max: 5 });
// => -33569

randomInt({ min: 10, max: 100 });
// => 66

randomInt({ min: -100, max: -10 });
// => -57

Note:

These min and max are inclusive, so they are included in the range.

This means randomInt({ min: -2, max: 2 }) would return either -2, -1, 0, 1, or 2.

// Specific case
-2 <= random number <= 2

// General case
min <= random number <= max

Related

• random-natural - Return a random natural number.
• random-bool - Return a random boolean (true/false).
• random-char - Return a random char.
• random-index - Return a random array-like index.
• random-decimal - Return a random decimal.
• random-binary - Return a random binary number.
• random-octal - Return a random octal number.
• random-hexadecimal - Return a random hexadecimal number.
• random-unicode - Return a random unicode.

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.