Interface TerminalService

Hierarchy

TerminalService

Index

Properties

Methods

Properties

Readonly all

all: TerminalWidget[]

Readonly currentTerminal

currentTerminal: undefined | TerminalWidget

Readonly lastUsedTerminal

lastUsedTerminal: undefined | TerminalWidget

Readonly onDidChangeCurrentTerminal

onDidChangeCurrentTerminal: Event<undefined | TerminalWidget>

Readonly onDidCreateTerminal

onDidCreateTerminal: Event<TerminalWidget>

Methods

activateTerminal

activateTerminal(terminal: TerminalWidget): void

- Defined in packages/terminal/src/browser/base/terminal-service.ts:37
Display new terminal widget.

deprecated

use #open

Parameters
- terminal: TerminalWidget
  
  widget to attach.
Returns void

getById

getById(id: string): undefined | TerminalWidget

- Defined in packages/terminal/src/browser/base/terminal-service.ts:47
Parameters
- id: string
  
  the widget id (NOT the terminal id!)
Returns undefined | TerminalWidget

the widget

getByTerminalId

getByTerminalId(terminalId: number): undefined | TerminalWidget

- Defined in packages/terminal/src/browser/base/terminal-service.ts:53
Parameters
- terminalId: number
Returns undefined | TerminalWidget

the widget

getDefaultShell

getDefaultShell(): Promise<string>

- Defined in packages/terminal/src/browser/base/terminal-service.ts:58
Returns detected default shell.

Returns Promise<string>

newTerminal

newTerminal(options: TerminalWidgetOptions): Promise<TerminalWidget>

- Defined in packages/terminal/src/browser/base/terminal-service.ts:30
Create new terminal with predefined options.

Parameters
- options: TerminalWidgetOptions
  
  terminal options.
Returns Promise<TerminalWidget>

open

open(terminal: TerminalWidget, options?: WidgetOpenerOptions): void

- Defined in packages/terminal/src/browser/base/terminal-service.ts:39
Parameters
- terminal: TerminalWidget
- Optional options: WidgetOpenerOptions
Returns void