# @dmhtoo/random-int

> Generate a random integer in Javascript (ES6), within a given range.

Latest version **2.1.2** (published 2020-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dmhtoo/random-int
pnpm add @dmhtoo/random-int
yarn add @dmhtoo/random-int
bun add @dmhtoo/random-int
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2020-08-07 |
| First published | 2020-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dave Held |
| Maintainers | dmhtoo |
| Keywords | integer, math, number, random, typescript |

## Links

- npm: https://www.npmjs.com/package/@dmhtoo/random-int
- Repository: https://github.com/fauteuil/random-int
- Homepage: https://github.com/fauteuil/random-int#readme
- Issues: https://github.com/fauteuil/random-int/issues
- npm.io page: https://npm.io/package/@dmhtoo/random-int

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

- 2.1.2 (latest) — 2020-08-07
- 2.1.1 — 2020-08-06
- 2.1.0 — 2020-08-06
- 2.0.1 — 2020-07-07
- 2.0.0 — 2020-07-07
- 1.0.1 — 2020-01-09
- 1.0.0 — 2020-01-08

## README

# **Random integer**

### Generate a random integer in Javascript (ES6), within a given range

**This package is compatible with Typescript**

## **Installation**

> `npm install random-int --save`

or  

> `yarn add random-int`  

---

## **Syntax**

> **`randomInt(low, high);`**

### **Parameters**

- `low`:
  Optional minimum value (included). This defaults to `1`.
- `high`:
  Optional maximum value (included). This defaults to `100`.

### **Return value**  

- `randomInt` will return a randomly generated `Integer`, *including* the `low` and `high` limits.

---

## **Usage**

**Import the `randomInt` function**

```
import { randomInt } from "@dmhtoo/random-int";
```

or

```
const { randomInt } = require("@dmhtoo/random-int")
```

**Sample implementations**

```  
// Returns a random integer between default limits of 1 and 100, inclusive.
const myRandomInteger = randomInt();

// Returns a random integer between 1 and 10, inclusive.
const myRandomInteger = randomInt(1, 10);
```

---

## **References**  

- [W3Schools Javascript Random](https://www.w3schools.com/js/js_random.asp "W3Schools Javascript Random")
- [MDN Math.random](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random "MDN Math.random")
- [MDN Math.floor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor "MDN Math.floor")

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