Class TerminalWidget`Abstract`

Terminal UI widget.

Hierarchy (view full)

BaseWidget
- TerminalWidget
  - TerminalWidgetImpl

Constructors

constructor

new TerminalWidget(options?): TerminalWidget
Parameters
- Optional options: IOptions
Returns TerminalWidget
Inherited from BaseWidget.constructor
- Defined in packages/core/lib/browser/widgets/widget.d.ts:59

Properties

`Abstract` buffer

buffer: TerminalBuffer

`Readonly` `Abstract` dimensions

dimensions: TerminalDimensions

`Abstract` envVarCollectionDescriptionsByExtension

envVarCollectionDescriptionsByExtension: Promise<Map<string, (undefined | string | MarkdownString)[]>>

The ids of extensions contributing to the environment of this terminal mapped to the provided description for their changes.

`Readonly` `Abstract` exitStatus

exitStatus: undefined | TerminalExitStatus

`Readonly` `Abstract` hiddenFromUser

hiddenFromUser: boolean

Terminal widget can be hidden from users until explicitly shown once.

`Readonly` `Abstract` kind

kind: string

Terminal kind that indicates whether a terminal is created by a user or by some extension for a user

lastCwd

lastCwd: URI

The last CWD assigned to the terminal, useful when attempting getCwdURI on a task terminal fails

`Readonly` `Abstract` location

location: TerminalLocationOptions

The position of the terminal widget.

`Abstract` onData

onData: Event<string>

Event that fires when the terminal input data

`Abstract` onDidOpen

onDidOpen: Event<void>

Event that fires when the terminal is connected or reconnected

`Abstract` onDidOpenFailure

onDidOpenFailure: Event<void>

Event that fires when the terminal fails to connect or reconnect

`Abstract` onKey

onKey: Event<{
domEvent: KeyboardEvent;
key: string;
}>

Event that fires when the terminal receives a key event.

Type declaration

domEvent: KeyboardEvent
key: string

`Abstract` onOutput

onOutput: Event<string>

`Abstract` onSizeChanged

onSizeChanged: Event<{
cols: number;
rows: number;
}>

Event that fires when the terminal size changed

Type declaration

cols: number
rows: number

`Abstract` onTerminalDidClose

onTerminalDidClose: Event<TerminalWidget>

Event which fires when terminal did closed. Event value contains closed terminal widget definition.

`Abstract` processId

processId: Promise<number>

`Abstract` processInfo

processInfo: Promise<TerminalProcessInfo>

Get the current executable and arguments.

`Readonly` `Abstract` terminalId

terminalId: number

Methods

`Abstract` clearOutput

clearOutput(): void
Cleat terminal output.

Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:156

`Abstract` executeCommand

executeCommand(commandOptions): Promise<void>
Resolves when the command is successfully sent, this doesn't mean that it was evaluated. Might reject if terminal wasn't properly started yet.

Note that this method will try to escape your arguments as if it was someone inputting everything in a shell.

Supported shells: bash, cmd.exe, wsl.exe, pwsh/powershell.exe
Parameters
- commandOptions: CommandLineOptions
Returns Promise<void>
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:114

`Abstract` getSearchBox

getSearchBox(): TerminalSearchWidget
Return Terminal search box widget.

Returns TerminalSearchWidget
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:172

`Abstract` hasChildProcesses

hasChildProcesses(): Promise<boolean>
Whether the terminal process has child processes.

Returns Promise<boolean>
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:176

`Abstract` resetTerminal

resetTerminal(): void
Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:147

`Abstract` resize

resize(cols, rows): void
Parameters
- cols: number
- rows: number
Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:167

`Abstract` selectAll

selectAll(): void
Select entire content in the terminal.

Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:161

`Abstract` sendText

sendText(text): void
Send text to the terminal server.
Parameters
- text: string
  text content.
Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:103

`Abstract` setTitle

setTitle(title): void
Parameters
- title: string
Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:178

`Abstract` start

start(id?): Promise<number>
Start terminal and return terminal id.
Parameters
- Optional id: number
  terminal id.
Returns Promise<number>
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:97

`Abstract` waitOnExit

waitOnExit(waitOnExit?): void
Parameters
- Optional waitOnExit: string | boolean
Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:180

`Abstract` write

write(data): void
Parameters
- data: string
Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:165

`Abstract` writeLine

writeLine(line): void
Parameters
- line: string
Returns void
- Defined in packages/terminal/src/browser/base/terminal-widget.ts:163

Class TerminalWidgetAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TerminalWidget

Properties

Abstract buffer

Readonly Abstract dimensions

Abstract envVarCollectionDescriptionsByExtension

Readonly Abstract exitStatus

Readonly Abstract hiddenFromUser

Readonly Abstract kind

lastCwd

Readonly Abstract location

Abstract onData

Abstract onDidOpen

Abstract onDidOpenFailure

Abstract onKey

Type declaration

domEvent: KeyboardEvent

key: string

Abstract onOutput

Abstract onSizeChanged

Type declaration

cols: number

rows: number

Abstract onTerminalDidClose

Abstract processId

Abstract processInfo

Readonly Abstract terminalId

Methods

Abstract clearOutput

Returns void

Abstract executeCommand

Parameters

Returns Promise<void>

Abstract getSearchBox

Returns TerminalSearchWidget

Abstract hasChildProcesses

Returns Promise<boolean>

Abstract resetTerminal

Returns void

Abstract resize

Parameters

Returns void

Abstract scrollLineDown

Returns void

Abstract scrollLineUp

Returns void

Abstract scrollPageDown

Returns void

Abstract scrollPageUp

Returns void

Abstract scrollToBottom

Returns void

Abstract scrollToTop

Returns void

Abstract selectAll

Returns void

Abstract sendText

Parameters

Returns void

Abstract setTitle

Parameters

Returns void

Abstract start

Parameters

Returns Promise<number>

Abstract waitOnExit

Parameters

Returns void

Abstract write

Parameters

Returns void

Abstract writeLine

Class TerminalWidget`Abstract`

`Abstract` buffer

`Readonly` `Abstract` dimensions

`Abstract` envVarCollectionDescriptionsByExtension

`Readonly` `Abstract` exitStatus

`Readonly` `Abstract` hiddenFromUser

`Readonly` `Abstract` kind

`Readonly` `Abstract` location

`Abstract` onData

`Abstract` onDidOpen

`Abstract` onDidOpenFailure

`Abstract` onKey

`Abstract` onOutput

`Abstract` onSizeChanged

`Abstract` onTerminalDidClose

`Abstract` processId

`Abstract` processInfo

`Readonly` `Abstract` terminalId

`Abstract` clearOutput

`Abstract` executeCommand

`Abstract` getSearchBox

`Abstract` hasChildProcesses

`Abstract` resetTerminal

`Abstract` resize

`Abstract` scrollLineDown

`Abstract` scrollLineUp

`Abstract` scrollPageDown

`Abstract` scrollPageUp

`Abstract` scrollToBottom

`Abstract` scrollToTop

`Abstract` selectAll

`Abstract` sendText

`Abstract` setTitle

`Abstract` start

`Abstract` waitOnExit

`Abstract` write

`Abstract` writeLine