Serendipity
Math.random() for the rest of us.
Serendipity is a javascript library that generates custom random numbers.
Note that this currently just uses Math.random() for psuedo-random generation. If you need closer to true random, there are plenty of libraries made by people who know their stuff far better.
Installation
- Install by running
npm install --save-dev @cspruit/serendipity
in the same directory as the package.json file lives.
Usage
Random
- Generates a random number based off of Math.random
- max : number - optional - Max range, exclusive.
- min : number - optional - Min range, inclusive
- useFractions - optional - Unless this is true, will return an integer
import {random} from '@cspruit/serendipity';
const randNormal = random(); // Returns 0-1, like Math.random()
const randMax = random(5); // Returns 0-4
const randMin = random(5, 1); // Returns 1-4
const randFloat = random(5, 1, true); // Returns a float from 1-4
Contributing
All contributions, suggestions, and issues are welcome!
Check out the Issues page. In general anything listed is up for grabs, though bugs tend to be more detailed than enhancements and might be better to pick up if starting out.
License
This project uses GPL 3.0.