1.0.22 • Published 6 years ago
rand-num-gen v1.0.22
rand-num-gen
A simple module for generating random numbers.
rng(30, 14, { float: true, decimal: 2, skip: [16, 17, 25, 29] });
Installing
$ npm i rand-num-gen
The export is { rng }
. Here's how to use it:
import { rng } from 'rand-num-gen';
console.log( rng(10, 1, { skip: [7, 8, 9] }) ); // Logs an integer to the console.
Syntax and Options
rng(max[, min[, options]])
Parameter | Syntax | Description/parameters |
---|---|---|
max | rng(max) | Required. An integer. The highest positive number returned from rng(max) . |
min | rng(max, min) | An integer. The lowest positive or negative number returned from rng(max, min) . |
float | rng(max, min, { float: bool }) | A boolean. Determines whether the returned value will be a float or an integer. |
decimal | rng(max, min, { decimal: n }) | An integer between 0 and 14. Determines how many places which will be displayed by the float. |
skip | rng(max, min, { skip: [integers] }) | An array of integers. Integers which will not be returned. |
Return value
A random integer or float.
Skipped integers will never be returned.
Integers passed with { skip: [integers] }
when { float: true }
will also cause floats starting with the skipped integers to never be returned.
An integer will be returned when { decimal: 0 }
.
Examples
Defaults:
rng(max, min = 0, { float: false, decimal: 14, skip: false })
rng(7); // Returns an integer between 0 and 7, both inclusive.
rng(7, 2); // Returns an integer between 2 and 7, both inclusive.
rng(7, 2, { float: true }); // Returns a float between 2.0 and 7.99999999999999, both inclusive.
rng(7, 2, { float: true, decimal: 2 }); // Returns a float with two decimal places between 2.00 and 7.99, both inclusive.
rng(7, 2, { float: true, decimal: 2, skip: [3, 4] }) // Returns a float with two decimal places between 2.00 and 7.99, both inclusive. Will never return a float between 3.00 and 4.99999999999999.
rng(7, 2, { skip: [3, 4] }) // Returns an integer between 2 and 7. Will never return 3 or 4.
License
MIT
1.0.22
6 years ago
1.0.21
6 years ago
1.0.20
6 years ago
1.0.19
6 years ago
1.0.18
6 years ago
1.0.17
6 years ago
1.0.16
6 years ago
1.0.15
6 years ago
1.0.14
6 years ago
1.0.13
6 years ago
1.0.12
6 years ago
1.0.11
6 years ago
1.0.10
6 years ago
1.0.9
6 years ago
1.0.8
6 years ago
1.0.7
6 years ago
1.0.6
6 years ago
1.0.5
6 years ago
1.0.4
6 years ago
1.0.3
6 years ago
1.0.2
6 years ago
1.0.1
6 years ago
1.0.0
6 years ago