Interface TerminalService

interface TerminalService {
    all: TerminalWidget[];
    currentTerminal: undefined | TerminalWidget;
    lastUsedTerminal: undefined | TerminalWidget;
    onDidChangeCurrentTerminal: Event<undefined | TerminalWidget>;
    onDidCreateTerminal: Event<TerminalWidget>;
    getById(id): undefined | TerminalWidget;
    getByTerminalId(terminalId): undefined | TerminalWidget;
    getDefaultShell(): Promise<string>;
    newTerminal(options): Promise<TerminalWidget>;
    open(terminal, options?): void;
}

Implemented by

TerminalFrontendContribution

Index

Properties

all currentTerminal lastUsedTerminal onDidChangeCurrentTerminal onDidCreateTerminal

Methods

getById getByTerminalId getDefaultShell newTerminal open

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

getById

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

getByTerminalId

getByTerminalId(terminalId): undefined | TerminalWidget
Parameters
- terminalId: number
Returns undefined | TerminalWidget
the widget
- Defined in packages/terminal/src/browser/base/terminal-service.ts:46

getDefaultShell

getDefaultShell(): Promise<string>
Returns detected default shell.

Returns Promise<string>
- Defined in packages/terminal/src/browser/base/terminal-service.ts:51

newTerminal

newTerminal(options): Promise<TerminalWidget>
Create new terminal with predefined options.
Parameters
- options: TerminalWidgetOptions
  terminal options.
Returns Promise<TerminalWidget>
- Defined in packages/terminal/src/browser/base/terminal-service.ts:30

open

open(terminal, options?): void
Parameters
- terminal: TerminalWidget
- Optional options: WidgetOpenerOptions
Returns void
- Defined in packages/terminal/src/browser/base/terminal-service.ts:32