Class TaskTerminalProcess

Hierarchy

TerminalProcess
- TaskTerminalProcess

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TaskTerminalProcess(options: TerminalProcessOptions, processManager: ProcessManager, ringBuffer: MultiRingBuffer, logger: ILogger): TaskTerminalProcess

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

Properties

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 = ...

Protected Readonly exitEmitter

exitEmitter: Emitter<IProcessExitEvent> = ...

exited

exited: boolean = false

Readonly id

id: number

Protected Readonly initialCwd

initialCwd: string

Readonly inputStream

inputStream: Writable

Protected Readonly logger

logger: ILogger

Protected Readonly options

options: TerminalProcessOptions

Readonly outputStream

outputStream: MultiRingBufferReadableStream = ...

Protected Readonly processManager

processManager: ProcessManager

Protected Readonly ringBuffer

ringBuffer: MultiRingBuffer

Protected Readonly startEmitter

startEmitter: Emitter<IProcessStartEvent> = ...

Protected Readonly terminal

terminal: undefined | IPty

Protected Readonly type

type: ProcessType

Accessors

arguments

get arguments(): string[]

- Defined in packages/process/src/node/terminal-process.ts:161
Returns string[]

executable

get executable(): string

- Defined in packages/process/src/node/terminal-process.ts:157
Returns string

killed

get killed(): boolean

- Defined in packages/process/src/node/process.ts:124
Returns boolean

onClose

get onClose(): Event<IProcessExitEvent>

- Defined in packages/process/src/node/process.ts:146
Waits for both process exit and for all the streams to be closed.

Returns Event<IProcessExitEvent>

onError

get onError(): Event<ProcessErrorEvent>

- Defined in packages/process/src/node/process.ts:139
Returns Event<ProcessErrorEvent>

onExit

get onExit(): Event<IProcessExitEvent>

- Defined in packages/process/src/node/process.ts:135
Wait for the process to exit, streams can still emit data.

Returns Event<IProcessExitEvent>

onStart

get onStart(): Event<IProcessStartEvent>

- Defined in packages/process/src/node/process.ts:128
Returns Event<IProcessStartEvent>

pid

get pid(): number

- Defined in packages/process/src/node/terminal-process.ts:152
Returns number

Methods

Protected checkTerminal

checkTerminal(): void

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

createOutputStream

createOutputStream(): MultiRingBufferReadableStream

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

Protected emitOnClose

emitOnClose(code?: number, signal?: string): void

Inherited from TerminalProcess.emitOnClose
- Defined in packages/process/src/node/process.ts:168
Emit the onClose event for this process. Only one of code and signal should be defined.

Parameters
- Optional code: number
- Optional signal: string
Returns void

Protected emitOnError

emitOnError(err: ProcessErrorEvent): void

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

Protected emitOnErrorAsync

emitOnErrorAsync(error: ProcessErrorEvent): Promise<void>

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

Protected emitOnExit

emitOnExit(code?: number, signal?: string): void

Inherited from TerminalProcess.emitOnExit
- Defined in packages/process/src/node/process.ts:158
Emit the onExit event for this process. Only one of code and signal should be defined.

Parameters
- Optional code: number
- Optional signal: string
Returns void

Protected emitOnStarted

emitOnStarted(): void

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

getCwdURI

getCwdURI(): Promise<string>

Inherited from TerminalProcess.getCwdURI
- Defined in packages/process/src/node/process.ts:205
Returns Promise<string>

the current working directory as a URI (usually file:// URI)

Protected handleOnError

handleOnError(error: ProcessErrorEvent): void

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

Protected handleOnExit

handleOnExit(event: IProcessExitEvent): void

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

Protected isForkOptions

isForkOptions(options: any): options is ForkOptions

Inherited from TerminalProcess.isForkOptions
- Defined in packages/process/src/node/process.ts:196
Parameters
- options: any
Returns options is ForkOptions

kill

kill(signal?: string): void

Inherited from TerminalProcess.kill
- Defined in packages/process/src/node/terminal-process.ts:174
Parameters
- Optional signal: string
Returns void

Protected onTerminalExit

onTerminalExit(code: undefined | number, signal: undefined | string): void

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

resize

resize(cols: number, rows: number): void

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

unregisterProcess

unregisterProcess(): void

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

write

write(data: string): void

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