Skip to content

Function: roll() ​

ts
function roll(
   spec, 
   source?, 
   when?
): Roll;

Defined in: src/dice.ts:1024

Throw the dice. The source is crypto unless a seeded one is given. The third argument is when the roll is made, in epoch milliseconds (now, unless given), or options: { at, maxDice }. A spec asking for more than ten dice is brought to ten unless maxDice says otherwise, up to MAX_DICE_BY_CODE.

Parameters ​

spec ​

Partial<RollSpec>

source? ​

RandomSource = ...

when? ​

number | RollOptions

Returns ​

Roll

MIT © John Morris