kotlin-vscode/vscode/ExtensionTerminalOptions

ExtensionTerminalOptions

interface ExtensionTerminalOptions(source)

Value-object describing what options a virtual process terminal should use.

Properties

The icon ThemeColor for the terminal. The standard terminal.ansi* theme keys are recommended for the best contrast and consistency across themes.

iconPath

abstract var iconPath: IconPath?

The icon path or ThemeIcon for the terminal.

isTransient

abstract var isTransient: Boolean?

Opt-out of the default terminal persistence on restart and reload. This will only take effect when terminal.integrated.enablePersistentSessions is enabled.

location

abstract var location: JsAny?

The TerminalLocation or TerminalEditorLocationOptions or TerminalSplitLocationOptions for the terminal.

name

abstract var name: String

A human-readable string which will be used to represent the terminal in the UI.

pty

abstract var pty: Pseudoterminal

An implementation of Pseudoterminal that allows an extension to control a terminal.

shellIntegrationNonce

abstract var shellIntegrationNonce: String?

The nonce to use to verify shell integration sequences are coming from a trusted source. An example impact of UX of this is if the command line is reported with a nonce, it will not need to verify with the user that the command line is correct before rerunning it via the shell integration command decoration.