Home > @rushstack/terminal > ConsoleTerminalProvider

ConsoleTerminalProvider class

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Terminal provider that prints to STDOUT (for log- and verbose-level messages) and STDERR (for warning- and error-level messages).

Signature:

export declare class ConsoleTerminalProvider implements ITerminalProvider 

Implements: ITerminalProvider

Constructors

Constructor	Modifiers	Description
(constructor)(options)		(BETA) Constructs a new instance of the ConsoleTerminalProvider class

Properties

Property	Modifiers	Type	Description
debugEnabled		boolean	(BETA) If true, debug-level messages should be written to the console.
eolCharacter	readonly	string	(BETA) This property should return the newline character the terminal provider expects.
supportsColor	readonly	boolean	(BETA) This property should return true only if the terminal provider supports rendering console colors.
supportsColor	static readonly	boolean	(BETA)
verboseEnabled		boolean	(BETA) If true, verbose-level messages should be written to the console.

Methods

Method	Modifiers	Description
write(data, severity)		(BETA) This function gets called on every terminal provider upon every message function call on the terminal instance.