interface

DriverChannel

typescript

interface DriverChannel

Communication channel returned by driver spawn.

The channel provides a unified interface for sending messages, handling events, and managing the connection lifecycle.

Properties

isConnected(readonly)

boolean

Whether the channel is connected

pid(readonly)

number

Process ID (undefined for worker_threads)

close(): Promise<void>

Close the channel

Returns

Promise<void>

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

Parameters

handler:() => void

Returns

void

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

Parameters

handler:(error: Error) => void

Returns

void

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

Parameters

handler:(message: DriverMessage) => void

Returns

void

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

Parameters

handler:(reason: ShutdownReason) => void

Returns

void

send(message: DriverMessage): Promise<void>

Send a message through the channel

Parameters

Returns

Promise<void>