RoadmapShopEvents
Skip to main content

Home > @rushstack/node-core-library > ConsoleTerminalProvider

ConsoleTerminalProvider class

This API is provided as a 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 messsages).

Signature:
export declare class ConsoleTerminalProvider implements ITerminalProvider
Implements: [ITerminalProvider](/pages/node-core-library.iterminalprovider)

Constructors

ConstructorModifiersDescription
(constructor)(options)(BETA) Constructs a new instance of the ConsoleTerminalProvider class

Properties

PropertyModifiersTypeDescription
debugEnabledboolean(BETA) If true, debug-level messages should be written to the console.
eolCharacterstring(BETA) This property should return the newline character the terminal provider expects.
supportsColorboolean(BETA) This property should return true only if the terminal provider supports rendering console colors.
verboseEnabledboolean(BETA) If true, verbose-level messages should be written to the console.

Methods

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