Skip to main content

Interface: WebSocketHandlers

Event handlers for WebSocket connections upgraded via Server.upgrade.

Methods​

close()?​

optional close(ws, code, reason): void

Called when the WebSocket connection is closed.

Parameters​

ws​

ServerWebSocket

code​

number

reason​

string

Returns​

void

error()?​

optional error(ws, error): void

Called when an error occurs on the WebSocket connection.

Parameters​

ws​

ServerWebSocket

error​

Error

Returns​

void

message()?​

optional message(ws, data): void

Called when a message is received.

Parameters​

ws​

ServerWebSocket

data​

string

Returns​

void

open()?​

optional open(ws): void

Called when a WebSocket connection is established.

Parameters​

ws​

ServerWebSocket

Returns​

void