README.md

weighted-random

Choose a random value from a fixed list of choices. Treat some values as more likely than others.

Installation

npm install @pqt/weighted-random
# OR
yarn add @pqt/weighted-random

Usage

TypeScript

import { weightedRandom, Items } from "@pqt/weighted-random";

const items: Items = [
  ["Audi", 3],
  ["BMW", 1],
  ["Ferrari", 7],
  ["Lamborghini", 7],
  ["RAM", 4],
  ["Tesla", 6]
];

weightedRandom(items); // => "Lamborghini" (OR any of the other options with a variability based on weight)

JavaScript

import { weightedRandom } from "@pqt/weighted-random";

weightedRandom([
  ["Audi", 3],
  ["BMW", 1],
  ["Ferrari", 7],
  ["Lamborghini", 7],
  ["RAM", 4],
  ["Tesla", 6]
]); // => "Lamborghini" (OR any of the other options with a variability based on weight)

License

MIT