Class TaskTerminalProcess

Run arbitrary processes inside pseudo-terminals (PTY).

Note: a PTY is not a shell process (bash/pwsh/cmd...)

Hierarchy (View Summary)

TerminalProcess
- TaskTerminalProcess

Constructors

constructor

new TaskTerminalProcess(
    options: TerminalProcessOptions,
    processManager: ProcessManager,
    ringBuffer: MultiRingBuffer,
    logger: ILogger,
): TaskTerminalProcess
Parameters
- options: TerminalProcessOptions
- processManager: ProcessManager
- ringBuffer: MultiRingBuffer
- logger: ILogger
Returns TaskTerminalProcess
Inherited from TerminalProcess.constructor
- Defined in packages/process/src/node/terminal-process.ts:64

Properties

`Protected`_enableCommandHistory

_enableCommandHistory: boolean = false

Runtime-only property: whether to enable command history tracking for this task's terminal. This value is injected from the terminal.integrated.enableCommandHistory preference before the task is sent to the backend. It is not part of the task definition schema and should not be persisted in tasks.json.

`Protected`_endOscInjected

_endOscInjected: boolean = false

to avoid multiple end OSC injections

`Protected`_killed

_killed: boolean = false

attachmentAttempted

attachmentAttempted: boolean = false

`Protected` `Readonly`closeEmitter

closeEmitter: Emitter<IProcessExitEvent> = ...

`Protected` `Readonly`errorEmitter

errorEmitter: Emitter<ProcessErrorEvent> = ...

`Readonly`errorStream

errorStream: DevNullStream = ...

The stderr stream.

exited

exited: boolean = false

`Protected` `Readonly`exitEmitter

exitEmitter: Emitter<IProcessExitEvent> = ...

`Readonly`id

id: number

`Protected` `Readonly`initialCwd

initialCwd: string

`Readonly`inputStream

inputStream: Writable

The stdin stream.

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`options

options: TerminalProcessOptions

`Readonly`outputStream

outputStream: MultiRingBufferReadableStream = ...

The stdout stream.

`Protected` `Readonly`terminal

terminal: undefined | IPty

`Protected` `Readonly`type

type: ProcessType

Accessors

arguments

get arguments(): string[]
Returns string[]
Inherited from TerminalProcess.arguments
- Defined in packages/process/src/node/terminal-process.ts:211

executable

get executable(): string
Returns string
Inherited from TerminalProcess.executable
- Defined in packages/process/src/node/terminal-process.ts:207

killed

get killed(): boolean
Returns boolean
Inherited from TerminalProcess.killed
- Defined in packages/process/src/node/process.ts:100

onClose

get onClose(): Event<IProcessExitEvent>
Waits for both process exit and for all the streams to be closed.

Returns Event<IProcessExitEvent>
Inherited from TerminalProcess.onClose
- Defined in packages/process/src/node/process.ts:122

onError

get onError(): Event<ProcessErrorEvent>
Returns Event<ProcessErrorEvent>
Inherited from TerminalProcess.onError
- Defined in packages/process/src/node/process.ts:115

onExit

get onExit(): Event<IProcessExitEvent>
Wait for the process to exit, streams can still emit data.

Returns Event<IProcessExitEvent>
Inherited from TerminalProcess.onExit
- Defined in packages/process/src/node/process.ts:111

onStart

get onStart(): Event<IProcessStartEvent>
Returns Event<IProcessStartEvent>
Inherited from TerminalProcess.onStart
- Defined in packages/process/src/node/process.ts:104

pid

get pid(): number
The OS process id.

Returns number
Inherited from TerminalProcess.pid
- Defined in packages/process/src/node/terminal-process.ts:202

Methods

`Protected`checkTerminal

checkTerminal(): void
Returns void
Inherited from TerminalProcess.checkTerminal
- Defined in packages/process/src/node/terminal-process.ts:264

createOutputStream

createOutputStream(): MultiRingBufferReadableStream
Returns MultiRingBufferReadableStream
Inherited from TerminalProcess.createOutputStream
- Defined in packages/process/src/node/terminal-process.ts:198

`Protected`emitOnClose

emitOnClose(code?: number, signal?: string): void
Emit the onClose event for this process. Only one of code and signal should be defined.
Parameters
- Optionalcode: number
- Optionalsignal: string
Returns void
Inherited from TerminalProcess.emitOnClose
- Defined in packages/process/src/node/process.ts:144

`Protected`emitOnError

emitOnError(err: ProcessErrorEvent): void
Parameters
- err: ProcessErrorEvent
Returns void
Inherited from TerminalProcess.emitOnError
- Defined in packages/process/src/node/process.ts:157

`Protected`emitOnErrorAsync

emitOnErrorAsync(error: ProcessErrorEvent): Promise<void>
Parameters
- error: ProcessErrorEvent
Returns Promise<void>
Inherited from TerminalProcess.emitOnErrorAsync
- Defined in packages/process/src/node/process.ts:162

`Protected`emitOnExit

emitOnExit(code?: number, signal?: string): void
Emit the onExit event for this process. Only one of code and signal should be defined.
Parameters
- Optionalcode: number
- Optionalsignal: string
Returns void
Inherited from TerminalProcess.emitOnExit
- Defined in packages/process/src/node/process.ts:134

`Protected`emitOnStarted

emitOnStarted(): void
Returns void
Inherited from TerminalProcess.emitOnStarted
- Defined in packages/process/src/node/process.ts:126

getCwdURI

getCwdURI(): Promise<string>
Returns Promise<string>
the current working directory as a URI (usually file:// URI)
Inherited from TerminalProcess.getCwdURI
- Defined in packages/process/src/node/process.ts:180

`Protected`handleOnError

handleOnError(error: ProcessErrorEvent): void
Parameters
- error: ProcessErrorEvent
Returns void
Inherited from TerminalProcess.handleOnError
- Defined in packages/process/src/node/process.ts:166

`Protected`handleOnExit

handleOnExit(event: IProcessExitEvent): void
Parameters
- event: IProcessExitEvent
Returns void
Inherited from TerminalProcess.handleOnExit
- Defined in packages/process/src/node/process.ts:148

`Protected`injectCommandEndOsc

injectCommandEndOsc(): void
Returns void
- Defined in packages/process/src/node/task-terminal-process.ts:73

injectCommandStartOsc

injectCommandStartOsc(command: string): void
injects the command to be tracked into the terminal output stream only if command history tracking is enabled
Parameters
- command: string
Returns void
- Defined in packages/process/src/node/task-terminal-process.ts:49

`Protected`isForkOptions

isForkOptions(options: unknown): options is ForkOptions
Parameters
- options: unknown
Returns options is ForkOptions
Inherited from TerminalProcess.isForkOptions
- Defined in packages/process/src/node/process.ts:171

kill

kill(signal?: string): void
Parameters
- Optionalsignal: string
Returns void
Overrides TerminalProcess.kill
- Defined in packages/process/src/node/task-terminal-process.ts:68

`Protected`onTerminalExit

onTerminalExit(code: undefined | number, signal: undefined | string): void
Parameters
- code: undefined | number
- signal: undefined | string
Returns void
Overrides TerminalProcess.onTerminalExit
- Defined in packages/process/src/node/task-terminal-process.ts:57

resize

resize(cols: number, rows: number): void
Parameters
- cols: number
- rows: number
Returns void
Inherited from TerminalProcess.resize
- Defined in packages/process/src/node/terminal-process.ts:230

setEnableCommandHistory

setEnableCommandHistory(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in packages/process/src/node/task-terminal-process.ts:41

unregisterProcess

unregisterProcess(): void
Returns void
Inherited from TerminalProcess.unregisterProcess
- Defined in packages/process/src/node/terminal-process.ts:220

write

write(data: string): void
Parameters
- data: string
Returns void
Inherited from TerminalProcess.write
- Defined in packages/process/src/node/terminal-process.ts:259

Class TaskTerminalProcess

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TaskTerminalProcess

Properties

Protected_enableCommandHistory

Protected_endOscInjected

Protected_killed

attachmentAttempted

Protected ReadonlycloseEmitter

Protected ReadonlyerrorEmitter

ReadonlyerrorStream

exited

Protected ReadonlyexitEmitter

Readonlyid

Protected ReadonlyinitialCwd

ReadonlyinputStream

Protected Readonlylogger

Protected Readonlyoptions

ReadonlyoutputStream

Protected ReadonlyprocessManager

Protected ReadonlyringBuffer

Protected ReadonlystartEmitter

Protected Readonlyterminal

Protected Readonlytype

Accessors

arguments

Returns string[]

executable

Returns string

killed

Returns boolean

onClose

Returns Event<IProcessExitEvent>

onError

Returns Event<ProcessErrorEvent>

onExit

Returns Event<IProcessExitEvent>

onStart

Returns Event<IProcessStartEvent>

pid

Returns number

Methods

ProtectedcheckTerminal

Returns void

createOutputStream

Returns MultiRingBufferReadableStream

ProtectedemitOnClose

Parameters

Returns void

ProtectedemitOnError

Parameters

Returns void

ProtectedemitOnErrorAsync

Parameters

Returns Promise<void>

ProtectedemitOnExit

Parameters

Returns void

ProtectedemitOnStarted

Returns void

getCwdURI

Returns Promise<string>

ProtectedhandleOnError

Parameters

Returns void

ProtectedhandleOnExit

Parameters

Returns void

ProtectedinjectCommandEndOsc

Returns void

injectCommandStartOsc

Parameters

`Protected`_enableCommandHistory

`Protected`_endOscInjected

`Protected`_killed

`Protected` `Readonly`closeEmitter

`Protected` `Readonly`errorEmitter

`Readonly`errorStream

`Protected` `Readonly`exitEmitter

`Readonly`id

`Protected` `Readonly`initialCwd

`Readonly`inputStream

`Protected` `Readonly`logger

`Protected` `Readonly`options

`Readonly`outputStream

`Protected` `Readonly`processManager

`Protected` `Readonly`ringBuffer

`Protected` `Readonly`startEmitter

`Protected` `Readonly`terminal

`Protected` `Readonly`type

`Protected`checkTerminal

`Protected`emitOnClose

`Protected`emitOnError

`Protected`emitOnErrorAsync

`Protected`emitOnExit

`Protected`emitOnStarted

`Protected`handleOnError

`Protected`handleOnExit

`Protected`injectCommandEndOsc

`Protected`isForkOptions

`Protected`onTerminalExit