Skip to content

Type Alias: CliSurroundings ​

ts
type CliSurroundings = object;

Defined in: src/cli.ts:19

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

Properties ​

env? ​

ts
optional env?: Record<string, string | undefined>;

Defined in: src/cli.ts:21

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


stdin? ​

ts
optional stdin?: string;

Defined in: src/cli.ts:23

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


colour? ​

ts
optional colour?: boolean;

Defined in: src/cli.ts:25

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


locale? ​

ts
optional locale?: string;

Defined in: src/cli.ts:27

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


now? ​

ts
optional now?: number;

Defined in: src/cli.ts:29

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


source? ​

ts
optional source?: RandomSource;

Defined in: src/cli.ts:31

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

MIT © John Morris