Interface WsRoute

One registered WebSocket route.

Since

0.1.0

interface WsRoute {
    handlers: WebSocketHandlers;
    heartbeat: boolean;
    path: string;
    protocols: readonly string[];
}

Index

Properties

handlers heartbeat path protocols

Properties

`Readonly`handlers

handlers: WebSocketHandlers

The application's lifecycle callbacks.

`Readonly`heartbeat

heartbeat: boolean

Whether this route participates in the shared heartbeat sweep. Defaults to true so existing routes are unaffected.

`Readonly`path

path: string

The exact path this route serves.

`Readonly`protocols

protocols: readonly string[]

Subprotocols this route accepts, empty when none are configured.