readme.md

randoma

User-friendly pseudorandom number generator (PRNG)

This is not cryptographically secure.

“Pull request welcome” for additional commonly used random methods.

Install

npm install randoma

Usage

import Randoma from 'randoma';

const random = new Randoma({seed: 10});

random.integer();
//=> 2027521326

random.integer();
//=> 677268843


(new Randoma({seed: '🦄'}).integer());
//=> 1659974344

(new Randoma({seed: '🦄'}).integer());
//=> 1659974344

API

const random = new Randoma(options)

options

Type: object

seed

Required
Type: string | number

Initialization seed.

Multiple instances of Randoma with the same seed will generate the same random numbers.

random.integer()

random.integerInRange(minimum, maximum)

random.float()

random.floatInRange(minimum, maximum)

random.boolean()

random.arrayItem(array)

random.date()

random.dateInRange(startDate, endDate)

random.color(saturation?)

Returns a random aesthetically pleasing color as a color object.

random.color(0.5).hex().toString()
//=> '#AAF2B0'

saturation

Type: number
Default: 0.5

A percentage in the range 0...1.

Randoma.seed()

Returns a random seed you could use in the seed option if you for some reason don't want deterministic randomness.

Related

• park-miller - Park-Miller pseudorandom number generator (PRNG)