Terminal

interface Terminal : DisposableLike(source)

An individual terminal instance within the integrated terminal.

Properties

The object used to initialize the terminal, this is useful for example to detecting the shell type of when the terminal was not launched by this extension or for detecting what folder the shell was launched in.

exitStatus

abstract val exitStatus: TerminalExitStatus?

The exit status of the terminal, this will be undefined while the terminal is active.

name

abstract val name: String

The name of the terminal.

processId

abstract val processId: PromiseLike<JsInt?>

The process ID of the shell process.

shellIntegration

abstract val shellIntegration: TerminalShellIntegration?

An object that contains shell integration-powered features for the terminal. This will always be undefined immediately after the terminal is created. Listen to window.onDidChangeTerminalShellIntegration to be notified when shell integration is activated for a terminal.

state

abstract val state: TerminalState

The current state of the Terminal.

Functions

dispose

abstract override fun dispose()

Dispose and free associated resources.

hide

abstract fun hide()

Hide the terminal panel if this terminal is currently showing.

sendText

abstract fun sendText(text: String, shouldExecute: Boolean = definedExternally)

Send text to the terminal. The text is written to the stdin of the underlying pty process (shell) of the terminal.

show

abstract fun show(preserveFocus: Boolean = definedExternally)

Show the terminal panel and reveal this terminal in the UI.