random-weighted-item

Generator of random item in array by probability function

Usage no npm install needed!

<script type="module">
  import randomWeightedItem from 'https://cdn.skypack.dev/random-weighted-item';
</script>

README

random-weighted-item

JavaScript library to get random item from an array by probability function. The probability function takes the current value and the current index respectively as arguments. The real probability to obtain a particular item is Math.exp(probabilityFunctionReturnedValue).

install

npm install --save random-weighted-item

usage

const getRandomItem = require('random-weighted-item').default;

const array = [3, 7, 1, 4, 2];
const getWeight = value => value;
getRandomItem(array, getWeight);

for other examples see https://github.com/oprogramador/random-weighted-item/blob/master/src/tests/getRandomItem.js