Definition of the terminal emulator.

Implements

Constructors

Properties

creationOptions: Readonly<TerminalOptions | ExtensionTerminalOptions>

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.

deferredProcessId: Deferred<number> = ...
exitStatus: undefined | TerminalExitStatus

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

Example: Show a notification with the exit code when the terminal exits with a non-zero exit code.

window.onDidCloseTerminal(t => {
if (t.exitStatus && t.exitStatus.code) {
vscode.window.showInformationMessage(`Exit code: ${t.exitStatus.code}`);
}
});
id: Deferred<string> = ...
name: string

Human readable representation of the terminal in the UI.

shellIntegration: undefined | TerminalShellIntegration = undefined

Stubbed

Terminal Shell Ingration

state: TerminalState = ...

The current state of the Terminal.

Accessors

Methods

  • Send text to the terminal.

    Parameters

    • text: string

      The text to send.

    • shouldExecute: boolean = true

      Indicates that the text being sent should be executed rather than just inserted in the terminal. The character added is \r, independent from the platform (compared to platform specific in vscode). This defaults to true.

    Returns void