# random-bool

> Return a random boolean value (true or false).

Latest version **1.0.2** (published 2016-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install random-bool
pnpm add random-bool
yarn add random-bool
bun add random-bool
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-04-25 |
| First published | 2016-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | bubkoo |
| Maintainers | bubkoo |
| Keywords | bool, boolean, generator, generate, random, randomly, randomize, chance, test, dice, mock |

## Links

- npm: https://www.npmjs.com/package/random-bool
- Repository: https://github.com/mock-end/random-bool
- Homepage: https://github.com/mock-end/random-bool#readme
- Issues: https://github.com/mock-end/random-bool/issues
- npm.io page: https://npm.io/package/random-bool

## Dependencies (1)

- [is-nil](https://npm.io/package/is-nil.md) ^1.0.1

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-04-25
- 1.0.1 — 2016-04-23
- 1.0.0 — 2016-04-15
- 0.0.0 — 2016-04-03

## README

# random-bool

> Return a random boolean value (`true` or `false`).


[![MIT License](https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square)](https://github.com/mock-end/random-bool/blob/master/LICENSE)

[![build:?](https://img.shields.io/travis/mock-end/random-bool/master.svg?style=flat-square)](https://travis-ci.org/mock-end/random-bool)
[![coverage:?](https://img.shields.io/coveralls/mock-end/random-bool/master.svg?style=flat-square)](https://coveralls.io/github/mock-end/random-bool)


## Install

```
$ npm install --save random-bool 
```


## Usage

> For more use-cases see the [tests](https://github.com/mock-end/random-bool/blob/master/test/spec/index.js).

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

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

// options
// - likelihood
```

The default likelihood of success (returning `true`) is `50%`:

```js
randomBool(); 
// => true
```

Can optionally specify the likelihood in percent:

```js
randomBool({ likelihood: 30 });
// => false
```

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

## Related

- [random-integral](https://github.com/mock-end/random-integral) - Return a random integer.
- [random-natural](https://github.com/mock-end/random-natural) - Return a random natural number.
- [random-decimal](https://github.com/mock-end/random-decimal) - Return a random decimal.
- [random-floating](https://github.com/mock-end/random-floating) - Return a random floating point number.
- [random-index](https://github.com/mock-end/random-index) - Return a random array-like index.
- [random-binary](https://github.com/mock-end/random-binary) - Return a random binary number.
- [random-octal](https://github.com/mock-end/random-octal) - Return a random octal number.
- [random-hexadecimal](https://github.com/mock-end/random-hexadecimal) - Return a random hexadecimal number.
- [random-unicode](https://github.com/mock-end/random-unicode) - Return a random unicode. 
- [random-char](https://github.com/mock-end/random-char) - Return a random char.


## Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please [create an issue](https://github.com/mock-end/random-bool/issues/new).

---
_Source: https://npm.io/package/random-bool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._