!NPM Version
!downloads
!GitHub Workflow Status
!Libraries.io dependency status for GitHub repo

rand-seed

A small seedable random number generator library written in TypeScript

The default Math.random() function doesn't allow for setting a seed. This library offers a number of different semi-random number generators which may be initialised with an arbitrary seed in string format, hence, making it possible to produce sequences of semi-random numbers that are always the same for a given seed. The implemented algorithms are detailed here (note that I am not the author of that post, I merely used it for the implementation of this library).

Installation

This package is available through _npm_:

``
npm install --save rand-seed
`

Usage

Either import directly

`html

`

or import in your own scripts using

`javascript
import Rand, { PRNG } from 'rand-seed';
`

Then simply create a new instance with an (optional) seed:

`javascript
const rand = new Rand('1234');

rand.next(); // Generate a new random number
`

If no seed is specified the call to rand.next() will simply be forwarded to Math.random(). In case of a supplied seed, the _sfc32_ algorithm will be used by default. Currently, three different algorithms are provided: _sfc32_, _mulberry32_ and _xoshiro128\\_. If you would like to use a different algorithm, create a new instance like so:

`javascript
// Create a new random number generator using the xoshiro128** algorithm
const rand = new Rand('1234', PRNG.xoshiro128ss);
`

Example

A simple example is included. This may be run with _node_: node example/index.js`