# random-number

> Generate pseudo-randum numbers

Latest version **0.0.9** (published 2017-08-15) · BSD-2-Clause license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2017-08-15 |
| First published | 2014-01-20 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | separate (@types/random-number) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | ashnur |
| Maintainers | ashnur |
| Keywords | random-number, random, random-integer |

## Links

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

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 0.0.9 (latest) — 2017-08-15
- 0.0.8 — 2017-08-15
- 0.0.7 — 2016-02-13
- 0.0.6 — 2014-02-13
- 0.0.4 — 2014-01-26
- 0.0.3 — 2014-01-20
- 0.0.2 — 2014-01-20
- 0.0.1 — 2014-01-20

## README

# random-number
generate a (pseudo-)random number

# install
`npm install random-number`

# usage
``` javascript
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 defined
- `max` : largest possible value to return. defaults to 1 or min + 1 if min is defined
- `integer` : do you want whole numbers to be returned, or not. defaults to false

### Examples
- all three

``` javascript
// 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

``` javascript
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:
``` javascript
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`

``` javascript
var rn = require('random-number');
var options = {
  min: 9874316514 // example input
}
rn(options) // example output → 9874316514.958157
```
- only `max`

``` javascript
var rn = require('random-number');
var options = {
  max: -9874316514 // example input , yes negative values do work
}
rn(options) // example output → -9874316514.075052
```
- only `integer`

``` javascript
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` and `max`

``` javascript
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` and `integer` or `max` and `integer`

``` javascript
// 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
```

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