Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/cli / CliIo

Interface: CliIo ​

Defined in: packages/cli/src/io.ts:9

Properties ​

PropertyTypeDescriptionDefined in
isTTYbooleanTTY-aware renderers may switch between live and plain output.packages/cli/src/io.ts:18

Methods ​

err() ​

ts
err(line): void;

Defined in: packages/cli/src/io.ts:11

Parameters ​

ParameterType
linestring

Returns ​

void


out() ​

ts
out(line): void;

Defined in: packages/cli/src/io.ts:10

Parameters ​

ParameterType
linestring

Returns ​

void


prompt() ​

ts
prompt(question): Promise<string | undefined>;

Defined in: packages/cli/src/io.ts:16

Asks one question and resolves with the answer line, or undefined when input is exhausted (EOF): the caller leaves the run suspended.

Parameters ​

ParameterType
questionstring

Returns ​

Promise&lt;string | undefined&gt;