Class Process`Abstract`

Hierarchy (view full)

Process
- RawProcess
- TerminalProcess

Implements

ManagedProcess

Index

Constructors

constructor

new Process(processManager, logger, type, options): Process
Parameters
- processManager: ManagedProcessManager
- logger: ILogger
- type: ProcessType
- options: ProcessOptions | ForkOptions
Returns Process
- Defined in packages/process/src/node/process.ts:88

Properties

`Protected` _killed

_killed: boolean = false

`Protected` `Readonly` closeEmitter

closeEmitter: Emitter<IProcessExitEvent> = ...

`Protected` `Readonly` errorEmitter

errorEmitter: Emitter<ProcessErrorEvent> = ...

`Readonly` `Abstract` errorStream

errorStream: Readable

The stderr stream.

`Protected` `Readonly` exitEmitter

exitEmitter: Emitter<IProcessExitEvent> = ...

`Readonly` id

id: number

`Protected` `Readonly` initialCwd

initialCwd: string

`Readonly` `Abstract` inputStream

inputStream: Writable

The stdin stream.

`Protected` `Readonly` logger

logger: ILogger

`Protected` `Readonly` options

options: ProcessOptions | ForkOptions

`Readonly` `Abstract` outputStream

outputStream: Readable

The stdout stream.

`Readonly` `Abstract` pid

pid: number

The OS process id.

`Protected` `Readonly` processManager

processManager: ManagedProcessManager

`Protected` `Readonly` startEmitter

startEmitter: Emitter<IProcessStartEvent> = ...

`Protected` `Readonly` type

type: ProcessType

Accessors

killed

get killed(): boolean
Returns boolean
Implementation of ManagedProcess.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>
Implementation of ManagedProcess.onClose
- Defined in packages/process/src/node/process.ts:122

onError

get onError(): Event<ProcessErrorEvent>
Returns Event<ProcessErrorEvent>
Implementation of ManagedProcess.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>
Implementation of ManagedProcess.onExit
- Defined in packages/process/src/node/process.ts:111

onStart

get onStart(): Event<IProcessStartEvent>
Returns Event<IProcessStartEvent>
Implementation of ManagedProcess.onStart
- Defined in packages/process/src/node/process.ts:104

Methods

`Protected` emitOnClose

emitOnClose(code?, signal?): void
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
- Defined in packages/process/src/node/process.ts:144

`Protected` emitOnError

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

`Protected` emitOnErrorAsync

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

`Protected` emitOnExit

emitOnExit(code?, signal?): void
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
- Defined in packages/process/src/node/process.ts:134

`Protected` emitOnStarted

emitOnStarted(): void
Returns void
- 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)
- Defined in packages/process/src/node/process.ts:180

`Protected` handleOnError

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

`Protected` handleOnExit

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

`Protected` isForkOptions

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

`Abstract` kill

kill(signal?): void
Parameters
- Optional signal: string
Returns void
Implementation of ManagedProcess.kill
- Defined in packages/process/src/node/process.ts:98