# random-natural

> Return a natural number.

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

## Install

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

## 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.3 |
| Published | 2016-04-25 |
| First published | 2016-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | bubkoo |
| Maintainers | bubkoo |
| Keywords | natural, integer, number, generator, generate, random, randomly, randomize, chance, test, dice, mock |

## Links

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

## Dependencies (2)

- [max-safe-int](https://npm.io/package/max-safe-int.md) ^1.0.0
- [random-integral](https://npm.io/package/random-integral.md) ^1.0.3

## 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.3 (latest) — 2016-04-25
- 1.0.2 — 2016-04-23
- 1.0.1 — 2016-04-19
- 1.0.0 — 2016-04-15
- 0.0.0 — 2016-04-04

## README

# random-natural

> Return a [natural number](https://en.wikipedia.org/wiki/Natural_number).

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

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


## Install

```
$ npm install --save random-natural
```

## Usage

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

```js
var randomNatural = require('random-natural');

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

// options
// - min
// - max
```

By default it will return an integer between `0` and `9007199254740992`:

```js
randomNatural();
// => 9527
```

Can optionally provide min and max:

```js
randomNatural({ max: 5 });
// => 3

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

**Note**:

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

This means `randomNatural({ min: 1, max: 3 })` would return either `1`, `2`, or `3`.

```js
// Specific case
1 <= random number <= 3

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

## Related

- [random-integral](https://github.com/mock-end/random-integral) - Return a random integer.
- [random-bool](https://github.com/mock-end/random-bool) - Return a random boolean (true/false).
- [random-char](https://github.com/mock-end/random-char) - Return a random char.
- [random-index](https://github.com/mock-end/random-index) - Return a random array-like index.
- [random-decimal](https://github.com/mock-end/random-decimal) - Return a random decimal.
- [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. 

## Contributing

Pull requests and stars are highly welcome.

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

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