Class RawProcess

Hierarchy (View Summary)

Process
- RawProcess

Index

Constructors

constructor

new RawProcess(
    options: RawProcessOptions | RawForkOptions,
    processManager: ProcessManager,
    logger: ILogger,
): RawProcess
Parameters
- options: RawProcessOptions | RawForkOptions
- processManager: ProcessManager
- logger: ILogger
Returns RawProcess
Overrides Process.constructor
- Defined in packages/process/src/node/raw-process.ts:69

Properties

`Protected`_killed

_killed: boolean = false

`Protected` `Readonly`closeEmitter

closeEmitter: Emitter<IProcessExitEvent> = ...

`Protected` `Readonly`errorEmitter

errorEmitter: Emitter<ProcessErrorEvent> = ...

`Readonly`errorStream

errorStream: Readable

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: ProcessOptions | ForkOptions

`Readonly`outputStream

outputStream: Readable

The stdout stream.

`Readonly`process

process: undefined | ChildProcess

If the process fails to launch, it will be undefined.

`Protected` `Readonly`processManager

processManager: ManagedProcessManager

`Protected` `Readonly`startEmitter

startEmitter: Emitter<IProcessStartEvent> = ...

`Protected` `Readonly`type

type: ProcessType

Accessors

killed

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

onError

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

onStart

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

pid

get pid(): number
The OS process id.

Returns number
Overrides Process.pid
- Defined in packages/process/src/node/raw-process.ts:143

Methods

`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 Process.emitOnClose
- Defined in packages/process/src/node/process.ts:144

`Protected`emitOnError

emitOnError(err: ProcessErrorEvent): void
Parameters
- err: ProcessErrorEvent
Returns void
Inherited from Process.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 Process.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 Process.emitOnExit
- Defined in packages/process/src/node/process.ts:134

`Protected`emitOnStarted

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

`Protected`handleOnError

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

`Protected`handleOnExit

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

`Protected`isForkOptions

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

kill

kill(signal?: string): void
Parameters
- Optionalsignal: string
Returns void
Overrides Process.kill
- Defined in packages/process/src/node/raw-process.ts:150