Skip to main content

RenderOptions

RenderOptions = object

Properties

PropertyTypeDescription

debug?

boolean

If true, each update will be rendered as a separate output, without replacing the previous one.

Default

false;

exitOnCtrlC?

boolean

Configure whether Ink should listen to Ctrl+C keyboard input and exit the app. This is needed in case process.stdin is in raw mode, because then Ctrl+C is ignored by default and process is expected to handle it manually.

Default

true;

patchConsole?

boolean

Patch console methods to ensure console output doesn't mix with Ink output.

Default

true;

stderr?

NodeJS.WriteStream

Error stream.

Default

process.stderr;

stdin?

NodeJS.ReadStream

Input stream where app will listen for input.

Default

process.stdin;

stdout?

NodeJS.WriteStream

Output stream where app will be rendered.

Default

process.stdout;