Class Child

Child class

This class is used to create a child process or worker thread, and allows using isolated processes or threads for processing jobs.

Hierarchy

EventEmitter
- Child

Index

Constructors

Properties

childProcess processFile worker

Accessors

exitCode killed pid signalCode

Methods

hasProcessExited init kill send

Constructors

constructor

new Child(mainFile, processFile, opts?): Child
Parameters
- mainFile: string
- processFile: string
- opts: SandboxedOptions = ...
Returns Child
Overrides EventEmitter.constructor
- Defined in classes/child.ts:41

Properties

childProcess

childProcess: ChildProcess

processFile

processFile: string

worker

worker: Worker

Accessors

exitCode

get exitCode(): number
Returns number
- Defined in classes/child.ts:63

killed

get killed(): boolean
Returns boolean
- Defined in classes/child.ts:71

pid

get pid(): number
Returns number
- Defined in classes/child.ts:51

signalCode

get signalCode(): number
Returns number
- Defined in classes/child.ts:67

Methods

hasProcessExited

hasProcessExited(): boolean
Returns boolean
- Defined in classes/child.ts:213

init

init(): Promise<void>
Returns Promise<void>
- Defined in classes/child.ts:78

kill

kill(signal?, timeoutMs?): Promise<void>
Parameters
- signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'
- Optional timeoutMs: number
Returns Promise<void>
- Defined in classes/child.ts:152

send

send(msg): Promise<void>
Parameters
- msg: any
Returns Promise<void>
- Defined in classes/child.ts:126

Generated using TypeDoc