Skip to the content

Korokoroコロコロ

Roll mixed dice or type notation, compare exact probabilities, keep a history and replay seeded rolls.

Korokoro describes something small rolling in Japanese. About the name

Contents

Reference · Rolls and exact odds

addToHistoryfunction

Add a roll to the end, oldest dropped past the limit. Returns a new array.

Import it

import { addToHistory } from "@johnmorrisdotca/korokoro";

Definition

function addToHistory(history: readonly Roll[], roll: Roll, limit?: number): Roll[]

Parameters

NameTypeDescription
historyreadonly Roll[]

Completed rolls, newest first where the history API requires it.

rollRoll

The completed roll to read or record.

limit (optional)number

The maximum number of records retained.

Returns

Roll[]

Add a roll to the end, oldest dropped past the limit. Returns a new array.

Examples

import { addToHistory } from "@johnmorrisdotca/korokoro";
import { normalizeSpec, rollFrom } from "@johnmorrisdotca/korokoro";
const spec = normalizeSpec({ count: 2, sides: 6 });
const sample = rollFrom(spec, [2, 5], "saved", 0, null)!;
console.log(addToHistory([], sample).length);
1

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/korokoro 1.16.0.