interface

Connection

typescript

interface Connection

Active connection interface

Properties

isConnected

boolean

Whether the connection is active

socket

Socket

Underlying socket

close(): Promise<void>

Close the connection

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: TypedResult) => void): void

Parameters

handler:(message: TypedResult) => void

Returns

void

send(message: TypedMessage<T>): Promise<void>

Send a message through the connection

Parameters

Returns

Promise<void>