Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Terminal

An active terminal with connected TTY.

Hierarchy

  • Terminal

Index

Properties

Methods

Properties

environment

environment: TerminalEnvironment

onDidAppendViewer

onDidAppendViewer: Event<Viewer>

sessionConfiguration

sessionConfiguration: SessionConfiguration

The session configuration associated with this terminal.

Use getSessionSettings() to fetch extension settings.

Methods

getExtratermCookieName

  • getExtratermCookieName(): string

  • Get the name of the Extraterm terminal integration cookie.

    Returns string

getExtratermCookieValue

  • getExtratermCookieValue(): string

  • Get the values of the Extraterm terminal integration cookie specific to this terminal.

    Returns string

getSessionSettings

  • getSessionSettings(name: string): Object

  • Get the extension settings associated with this terminal.

    Parameters

    • name: string

      the same name passed to Window.registerSessionSettingsEditor().

    Returns Object

getTab

  • getTab(): Tab

  • Get the tab which holds this terminal.

    Returns Tab

getViewers

  • Get a list of viewers inside this terminal.

    Returns Viewer[]

isAlive

  • isAlive(): boolean

  • True if this terminal is still open.

    Once the uesr closes a terminal tab and the tab disappears, then this will return false.

    Returns boolean

openTerminalBorderWidget

  • openTerminalBorderWidget(name: string): any

  • Parameters

    • name: string

    Returns any

type

  • type(text: string): void

  • Type a string of text into the terminal.

    This is effectively the same as though the user typed into the terminal. Note that the enter key should be represented as \r.

    Parameters

    • text: string

    Returns void

Generated using TypeDoc