Class ShellProcess

Run arbitrary processes inside pseudo-terminals (PTY).

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

Hierarchy (View Summary)

TerminalProcess
- ShellProcess

Constructors

constructor

new ShellProcess(
    options: ShellProcessOptions,
    processManager: ProcessManager,
    ringBuffer: MultiRingBuffer,
    logger: ILogger,
    environmentUtils: EnvironmentUtils,
): ShellProcess
Parameters
- options: ShellProcessOptions
- processManager: ProcessManager
- ringBuffer: MultiRingBuffer
- logger: ILogger
- environmentUtils: EnvironmentUtils
Returns ShellProcess
Overrides TerminalProcess.constructor
- Defined in packages/terminal/src/node/shell-process.ts:57

Properties

`Protected`_killed

_killed: boolean

`Protected` `Readonly`closeEmitter

closeEmitter: Emitter<IProcessExitEvent>

`Protected` `Readonly`errorEmitter

errorEmitter: Emitter<ProcessErrorEvent>

`Readonly`errorStream

errorStream: DevNullStream

The stderr stream.

`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`processManager

processManager: ManagedProcessManager

`Protected` `Readonly`ringBuffer

ringBuffer: MultiRingBuffer

`Protected` `Readonly`startEmitter

startEmitter: Emitter<IProcessStartEvent>

`Protected` `Readonly`terminal

terminal: undefined | IPty

`Protected` `Readonly`type

type: ProcessType

`Protected` `Static`defaultCols

defaultCols: number = 80

`Protected` `Static`defaultRows

defaultRows: number = 24

Accessors

arguments

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

executable

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

killed

get killed(): boolean
Returns boolean
Inherited from TerminalProcess.killed
- Defined in packages/process/lib/node/process.d.ts:63

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/lib/node/process.d.ts:73

onError

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

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/lib/node/process.d.ts:68

onStart

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

pid

get pid(): number
The OS process id.

Returns number
Inherited from TerminalProcess.pid
- Defined in packages/process/lib/node/terminal-process.d.ts:51

Methods

`Protected`checkTerminal

checkTerminal(): void
Returns void
Inherited from TerminalProcess.checkTerminal
- Defined in packages/process/lib/node/terminal-process.d.ts:59

createOutputStream

createOutputStream(): MultiRingBufferReadableStream
Returns MultiRingBufferReadableStream
Inherited from TerminalProcess.createOutputStream
- Defined in packages/process/lib/node/terminal-process.d.ts:50

`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/lib/node/process.d.ts:84

`Protected`emitOnError

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

`Protected`emitOnErrorAsync

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

`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/lib/node/process.d.ts:79

`Protected`emitOnStarted

emitOnStarted(): void
Returns void
Inherited from TerminalProcess.emitOnStarted
- Defined in packages/process/lib/node/process.d.ts:74

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/lib/node/process.d.ts:94

`Protected`handleOnError

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

`Protected`handleOnExit

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

`Protected`isForkOptions

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

kill

kill(signal?: string): void
Parameters
- Optionalsignal: string
Returns void
Inherited from TerminalProcess.kill
- Defined in packages/process/lib/node/terminal-process.d.ts:56

`Protected`onTerminalExit

onTerminalExit(code: undefined | number, signal: undefined | string): void
Parameters
- code: undefined | number
- signal: undefined | string
Returns void
Inherited from TerminalProcess.onTerminalExit
- Defined in packages/process/lib/node/terminal-process.d.ts:54

resize

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

unregisterProcess

unregisterProcess(): void
Returns void
Inherited from TerminalProcess.unregisterProcess
- Defined in packages/process/lib/node/terminal-process.d.ts:55

write

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

`Static`getShellExecutableArgs

getShellExecutableArgs(): string[]
Returns string[]
- Defined in packages/terminal/src/node/shell-process.ts:91

`Static`getShellExecutablePath

getShellExecutablePath(): string
Returns string
- Defined in packages/terminal/src/node/shell-process.ts:79