View source

typedef ExtensionTerminalOptions

package vscode

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

Fields

pty:Pseudoterminal

An implementation of {@link Pseudoterminal} that allows an extension to control a terminal.

name:String

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

@:optionaloptionallocation:Null<EitherType<TerminalLocation, EitherType<TerminalEditorLocationOptions, TerminalSplitLocationOptions>>>

The {@link TerminalLocation} or {@link TerminalEditorLocationOptions} or {@link TerminalSplitLocationOptions} for the terminal.

@:optionaloptionalisTransient:Null<Bool>

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

@:optionaloptionaliconPath:Null<IconPath>

The icon path or {@link ThemeIcon} for the terminal.

@:optionaloptionalcolor:Null<ThemeColor>

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