Skip to content

RenderContext

The output decisions the framework will make for a given argv, resolved before .run().

Signatures

ts
interface RenderContext {}

Members

Properties

color

The gated ANSI palette the output channel will expose as out.color — identity formatters when color is off; color.isColorSupported is the boolean gate.

ts
color: Colors;

isHyperlinkSupported

Whether OSC 8 hyperlinks should be emitted (see out.isHyperlinkSupported).

ts
isHyperlinkSupported: boolean;

isTTY

The TTY status the output channel will carry.

ts
isTTY: boolean;

jsonMode

Whether a pre-separator --json puts the run in JSON mode.

ts
jsonMode: boolean;

See Also

Released under the MIT License.