Type Alias WebSocketHandlers<T>

Type definition for WebSocket event handlers.

type WebSocketHandlers<T = AnyJson> = {
    onAuthError?: MessageHandler<AuthReply>;
    onClose?: CloseHandler;
    onError?: ErrorHandler;
    onMessage: MessageHandler<Message<T>>;
}

Type Parameters

T = AnyJson

Index

Properties

onAuthError? onClose? onError? onMessage

Properties

`Optional`onAuthError

onAuthError?: MessageHandler<AuthReply>

Called if the authentication fails.

`Optional`onClose

onClose?: CloseHandler

Called on WebSocket close.

`Optional`onError

onError?: ErrorHandler

Called on WebSocket error.

onMessage

onMessage: MessageHandler<Message<T>>

Called on every Message. This is the main message handling callback.