Skip to content

RenderContextOptions ​

Inputs for resolveRenderContext. Pass the host facts (TTY status, environment) and any explicit overrides; the resolver applies the same gating .execute()/.run() feed into the output channel.

Signatures ​

ts
interface RenderContextOptions {}

Members ​

Properties ​

color ​

Explicitly enable or disable colors, winning over the auto-gate.

ts
color?: boolean;

env ​

Environment variables consulted for NO_HYPERLINKS/FORCE_HYPERLINKS (e.g. process.env).

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

isTTY ​

Whether stdout is connected to a TTY (e.g. process.stdout.isTTY).

ts
isTTY?: boolean;

jsonMode ​

Force JSON mode on regardless of argv.

ts
jsonMode?: boolean;

verbosity ​

Output verbosity override when argv does not contain root --quiet/-q.

ts
verbosity?: "normal" | "quiet";

See Also ​

Released under the MIT License.