Skip to content

mock-end/random-integral

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

random-integral

Return a random integer.

MIT License

build:? coverage:?

Install

$ npm install --save random-integral

Usage

For more use-cases see the tests

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

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

// options
// - min
// - max

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

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.

Releases

No releases published

Packages

No packages published