spaceblocks / aimless.js Goto Github PK

The missing JS randomness library. See a demo.

Outside of large game engines and frameworks, there is very little support for generating random numbers in JavaScript. Sure, there are quite a number of substitutes for the native Math.random function, but what if I wanted to generate a random number within a range? Better yet, what if I wanted to do anything but get a number between 0 and 1?

Aimless is the missing JS randomness library. It's tiny (< 6kB), unopinionated, dependency-free, and provides a variety of helpful random number utilities. Best of all, it's compatible with all your favorite PRNGs.

Follow these steps:

1. Install
2. Using Custom PRNG
3. Review API

Install and add it to your package.json dependencies.

$ npm install aimless.js --save

Then import utility functions into the file where you'll use them.

import { bool, intRange } from 'aimless.js'

Aimless.js is compatible with any custom PRNG that returns a number num >= 0 and num < 1. Every function accepts an engine to be used.

import { bool } from 'aimless.js'

const engine = () => 0
bool(engine) // false

Additionally, every function in Aimless has a counterpart named withEngine. This function will return its counterpart with a closure around your engine, so you don't need to pass it every time.

import { boolWithEngine } from 'aimless.js'

const engine = () => 0
const bool = boolWithEngine(engine)
bool() // false

Every function will default to using the provided defaultEngine if no custom engine is provided. The default engine uses crypto.getrandomvalues when available, with a fallback of Math.random.

• bool
• char
• customDist
• exponentialDist
• floatRange
• intRange
• intSequence
• normalDist
• normalFloat
• oneOf
• seedFunc
• sequence
• sign
• uniqFuncIntRange
• uniqFuncSequence
• uuid
• weighted

Returns either true or false.

Returns a random character from the provided string.

const randomChar = char('the missing JS randomness library')
// could return 's', ' ', 'l', etc

Returns a random number following a custom distribution of your choosing. function should take in a number between 0 and 1.

const randomOfCustomDist = customDist(
    (randomNumber) => randomNumber / 2
)

Returns a random number following an exponential distribution with the provided lambda.

const samples = []
const lambda = 0.5

for (let i = 0; i < 100000; i++) {
    const randomValue = exponentialDist(lambda)
    samples.push(randomValue)
}

// you can expect the mean of `samples` to be (1 / lambda) +/- 0.01,
// generating more samples will ensure a mean of (1 / lambda)

Returns a random float between min and max.

const randomFloat = floatRange(0.1, 0.2)

Returns a random integer between min and max.

const randomInteger = intRange(5, 10)

Returns an array with all integers between min and max in random order.

const intSeq = intSequence(-1, 3)
// could return [3,-1,2,1,0], [0,2,-1,3,1], etc

Returns a random number following a normal distribution with mean mean and standard deviation stdDev.

const samples = []

for (let i = 0; i < 100000; i++) {
    const randomValue = normalDist(0, 1)
    samples.push(randomValue)
}

// you can expect the mean of `samples` to be 0 +/- 0.01,
// generating more samples will ensure a mean of 0

Returns a random float between -1 and 1.

Returns a random item from the array provided.

const randomItem = oneOf([1,2,3])
const randomObj = oneOf([{a:1}, {b:2}, {c:3}])

Returns a seeded random number generator. Seeded RNGs produce random numbers, but are predictable if you use the same seed. note: the Park-Miller PRNG is used to provide the seeded function, therefore, an engine is not accepted.

const seededFunction = seedFunc(1)
seededFunction() // 0.000007825903601782307
seededFunction() // 0.13153778773875702
seededFunction() // 0.7556053220812281

const newSeeded = seedFunc(1)
newSeeded() // 0.000007825903601782307
newSeeded() // 0.13153778773875702
newSeeded() // 0.7556053220812281

Returns a new array with the same items contained in array but in random order.

const randomSeq = sequence([1,2,3])
// could return [3,1,2], [2,3,1], etc.

Returns either -1 or 1.

Returns a unique random number between min and max, using the provided engine. If no engine is passed, the defaultEngine will be used. If there are no unique values left to return, null will be returned.

const uniqueRNG = uniqFuncIntRange(1, 3)
uniqueRNG() // 2
uniqueRNG() // 3
uniqueRNG() // 1
uniqueRNG() // null

Returns a unique random number from the provided array, using the provided engine. If no engine is passed, the defaultEngine will be used. If there are no unique values left to return, null will be returned.

const uniqueRNG = uniqFuncSequence([10, 20, 30])
uniqueRNG() // 20
uniqueRNG() // 30
uniqueRNG() // 10
uniqueRNG() // null

Returns a valid RFC4122 version4 ID hex string, using the provided engine.

const id = uuid()
console.log(id) // ef486db4-7f49-43b3-a1ea-b0e0a22bc944

Returns one of the numbers provided, biased towards the corresponding weights provided. numbers can include floats.

const weightedDiceRoll = weighted(
    [1,2,3,4,5,6],
    [1,1,1,1,1,10]
)
// will return 6 much more often than the other options

Aimless relies on ES5 array methods, and is supported in all modern browsers. Support for legacy or depricated browsers is not planned.

MIT. © 2023 Christopher Cavalea