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

CliSurroundingstype

What the command line is run in. All of it is optional.

Import it

import type { CliSurroundings } from "@johnmorrisdotca/korokoro";

Definition

type CliSurroundings = {
    env?: Record<string, string | undefined>;
    stdin?: string;
    colour?: boolean;
    locale?: string;
    now?: number;
    source?: RandomSource;
};

Members

NameTypeDescription
env (optional)Record<string, string | undefined> | undefined

The environment, for the language (LC_ALL, LC_MESSAGES, LANG) and NO_COLOR.

stdin (optional)string | undefined

Standard input, when --stdin asks for it: one notation to a line.

colour (optional)boolean | undefined

Whether the output is a terminal that shows colour. NO_COLOR and --no-color still turn it off.

locale (optional)string | undefined

The system's language where the environment names none: what Intl says, on Windows.

now (optional)number | undefined

The time, in epoch milliseconds, for the rolls made. Now, unless given.

source (optional)RandomSource | undefined

Where unseeded rolls come from. The crypto generator, unless given.

Examples

import type { CliSurroundings } from "@johnmorrisdotca/korokoro";
const value: CliSurroundings = { env: {}, locale: "en" };
console.log(value.locale);
en

What it prints (run when this page was built)

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