API Reference/ChildProcessChannel
class

ChildProcessChannel

typescript

Channel implementation for child process driver.

Wraps a Connection and ChildProcess, providing the DriverChannel interface with optional reconnect and detach capabilities.

Methods

close(): Promise<void>

Close the channel

Returns

Promise<void>
disconnect(): Promise<void>

Disconnect from worker but keep process alive

Returns

Promise<void>
onClose(handler: () => void): void

Register a close handler

Parameters

handler:() => void

Returns

void
onError(handler: (error: Error) => void): void

Register an error handler

Parameters

handler:(error: Error) => void

Returns

void
onMessage(handler: (message: DriverMessage) => void): void

Register a message handler

Parameters

handler:(message: DriverMessage) => void

Returns

void
onShutdown(handler: (reason: ShutdownReason) => void): void

Register a shutdown handler

Parameters

handler:(reason: ShutdownReason) => void

Returns

void
reconnect(): Promise<void>

Reconnect to existing worker

Returns

Promise<void>
send(message: DriverMessage): Promise<void>

Send a message through the channel

Parameters

Returns

Promise<void>