random-number
v0.0.9
Published
Generate pseudo-randum numbers
Downloads
27,432
Maintainers
Readme
random-number
generate a (pseudo-)random number
install
npm install random-number
usage
var rn = require('random-number');
rn(); // sample output → 0.704848874360323 # yes, this is just Math.random(), but it has some options
default options
the exported function takes an option object with 3 meaningful properties
min
: smallest possible value to return. defaults to 0 or max - 1 if max is definedmax
: largest possible value to return. defaults to 1 or min + 1 if min is definedinteger
: do you want whole numbers to be returned, or not. defaults to false
Examples
- all three
// this is the functionality i like the most
var rn = require('random-number');
var options = {
min: -1000
, max: 1000
, integer: true
}
rn(options) // example outputs → -187, 636
If you need the same (or almost the same settings many time) you can create a generator instead of passing the options over and over again
var rn = require('random-number');
var gen = rn.generator({
min: -1000
, max: 1000
, integer: true
})
gen() // example outputs → -350
What is neat about generators, that you can overwrite any of the settings
generator( min, max, integer) - all arguments are optional:
var rn = require('random-number');
var gen = rn.generator({
min: -1000
, max: 1000
, integer: true
})
gen(500) // example outputs → 735
gen(500, null, false) // example outputs → 828.6001032683998
- only
min
var rn = require('random-number');
var options = {
min: 9874316514 // example input
}
rn(options) // example output → 9874316514.958157
- only
max
var rn = require('random-number');
var options = {
max: -9874316514 // example input , yes negative values do work
}
rn(options) // example output → -9874316514.075052
- only
integer
var rn = require('random-number');
var options = {
integer: true
}
// this is basically a true/false random generator, with 50% chance to return true
rn(options) // example output → 1
min
andmax
var rn = require('random-number');
var options = {
// example input , yes negative values do work
min: -10
, max: -1
}
rn(options) // example output → -2.47377512534149
min
andinteger
ormax
andinteger
// completely pointless, but whatever
var rn = require('random-number');
var options = {
min: 1000
, integer: true
}
rn(options) // example output → 1001
options = {
max: 1000
, integer: true
}
rn(options) // example output → 999