Interface ExtensionTerminalOptions

Options a virtual process terminal.

interface ExtensionTerminalOptions {
    color?: ThemeColor;
    iconPath?: IconPath;
    isTransient?: boolean;
    location?: TerminalLocation | TerminalEditorLocationOptions | TerminalSplitLocationOptions;
    name: string;
    pty: Pseudoterminal;
}

Properties

color? iconPath? isTransient? location? name pty

Properties

Optional color

color?: ThemeColor

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

Stubbed

Optional iconPath

iconPath?: IconPath

The icon path or ThemeIcon for the terminal.

Optional isTransient

isTransient?: boolean

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

Optional location

location?: TerminalLocation | TerminalEditorLocationOptions | TerminalSplitLocationOptions

The TerminalLocation or TerminalEditorLocationOptions or TerminalSplitLocationOptions for the terminal.

name

name: string

The name of the terminal.

pty

pty: Pseudoterminal

An implementation of Pseudoterminal where an extension can control it.

Settings

Member Visibility

Theme

On This Page

coloriconPathisTransientlocationnamepty