Home > @rushstack/terminal > ITerminalProvider

ITerminalProvider interface

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.

Implement the interface to create a terminal provider. Terminal providers can be registered to a Terminal instance to receive messages.

Signature:

export interface ITerminalProvider 

Properties

Property	Modifiers	Type	Description
eolCharacter		string	(BETA) This property should return the newline character the terminal provider expects.
supportsColor		boolean	(BETA) This property should return true only if the terminal provider supports rendering console colors.

Methods

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