@js-random/number/README.md

A simple and lightweight number randomizer for JavaScript (TypeScript friendly)

# `@js-random/number`

> A simple and lightweight number randomizer for JavaScript (TypeScript friendly)

## Installation

```
npm i -S @js-random/number
```

## Usage

**commonjs**:
```js
var randomNumber = require('@js-random/number').default;
```

**TS/ES6+**:
```ts
import randomNumber from '@js-random/number';
```

**`<script> tag`**:
```html
<script src="https://unpkg.com/@js-random/number"></script>
```

```ts
var number = randomNumber(); // from 0 to 100 (inclusive)
var fromTwoToTen = randomNumber(2, 10); // random number from `2` to `10` (inclusive)
```

## Global version

This package also has a global version, which introduces side-effects by exposing the api as `Number.random()` function.

### Import

**commonjs**:
```js
require('@js-random/number/lib/global');
```

**ES6+**:
```ts
import '@js-random/number/module/global';
```

**TS**:
```ts
import '@js-random/number/module/global';
```

**`<script> tag`**
```html
<script src="https://unpkg.com/@js-random/number/unpkg/global"></script>
```

### Usage

```ts
var number = Number.random(); // from 0 to 100 (inclusive)
var fromTwoToTen = Number.random(2, 10); // random number from `2` to `10` (inclusive)
```

## Other packages

Please, have a look at other packages from `@js-random` series:

- `@js-random/all` - all the randomizers in one package - [GitHub repo](https://github.com/Raiondesu/js-random/tree/master/packages/all#readme), [NPM](https://www.npmjs.com/@js-random/string)
- `@js-random/string` [GitHub repo](https://github.com/Raiondesu/js-random/tree/master/packages/string#readme), [NPM](https://www.npmjs.com/@js-random/string)
- `@js-random/boolean` [GitHub repo](https://github.com/Raiondesu/js-random/tree/master/packages/boolean#readme), [NPM](https://www.npmjs.com/@js-random/boolean)
- `@js-random/date` [GitHub repo](https://github.com/Raiondesu/js-random/tree/master/packages/date#readme), [NPM](https://www.npmjs.com/@js-random/date)
- `@js-random/function` [GitHub repo](https://github.com/Raiondesu/js-random/tree/master/packages/function#readme), [NPM](https://www.npmjs.com/@js-random/function)