random-bool

Return a random boolean value (true or false).

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
random-bool
001.0.27 years ago7 years agoMinified + gzip package size for random-bool in KB

Readme

random-bool
Return a random boolean value (true or false).

MIT License
build:? coverage:?

Install

$ npm install --save random-bool 

Usage

For more use-cases see the tests.

var randomBool = require('random-bool');

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

// options
// - likelihood

The default likelihood of success (returning true) is 50%:
randomBool(); 
// => true

Can optionally specify the likelihood in percent:
randomBool({ likelihood: 30 });
// => false

In this case only a 30% likelihood of true, and a 70% likelihood of false.

Related

Contributing

Pull requests and stars are highly welcome.
For bugs and feature requests, please create an issue.