# random-floating

> Return a random floating point number.

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

## Install

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

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

## Links

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

## Dependencies (5)

- [clamp](https://npm.io/package/clamp.md) ^1.0.1
- [tofixed](https://npm.io/package/tofixed.md) ^1.0.0
- [to-integer](https://npm.io/package/to-integer.md) ^1.0.1
- [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

- [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

- 1.0.1 (latest) — 2016-04-25
- 1.0.0 — 2016-04-23
- 0.0.0 — 2016-04-21

## README

# random-floating

> Return a random floating point number.

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

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


## Install

```
$ npm install --save random-floating
```

## Usage

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

```js
var randomFloat = require('random-floating');

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

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

By default it will return a fixed number of at most 4 digits after the decimal.

```js
randomFloat();
// range: -9007199254740992 to 9007199254740992
// => -211920142886.5024
```

**Note**: *at most* 4 digits. This because, unless we returned trailing zeroes (which aren’t allowed on the JavaScript float) we can’t guarantee 4 digits after the decimal. So if random chance comes back with `82383854.2000` then `82383854.2` is what will be returned.

Can optionally provide min and max:

```js
randomFloat({max: 5});
// => -239837235632.3785

randomFloat({min:10, max: 100});
// => 66.7269
```

**Note**: these `min` and `max` are **inclusive**, so they are included in the range.

To retrieve a set number of fixed digits after the decimal, provide it as an option:

```js
randomFloat({fixed: 7});
// => -749512327.7447168
```

Or combine them:

```js
randomFloat({min: 0, max: 100, fixed: 8});
// => 45.92367599
```

## 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-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-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.


## Contributing

Pull requests and stars are highly welcome.

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

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