VS Code API
    Preparing search index...

    Interface ExtensionTerminalOptions

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

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

    Properties

    color? iconPath? isTransient? location? name pty shellIntegrationNonce?

    Properties

    color?: ThemeColor

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

    iconPath?: IconPath

    The icon path or ThemeIcon for the terminal.

    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?:
        | TerminalEditorLocationOptions
        | TerminalSplitLocationOptions
        | TerminalLocation

    The TerminalLocation or TerminalEditorLocationOptions or TerminalSplitLocationOptions for the terminal.

    name: string

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

    pty: Pseudoterminal

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

    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.

    This should be used if the terminal includes custom shell integration support. It should be set to a random GUID. Inside the Pseudoterminal implementation, this value can be passed through in the relevant sequences to make them trusted.

    Settings

    Member Visibility

    On This Page

    Properties