Interface WebSocketRouteDefinition

The declarative form of one IWebSocketService.route() call — the entry an application writes instead of calling route() imperatively after start().

Since

0.3.0

interface WebSocketRouteDefinition {
    handlers: WebSocketHandlers;
    options?: WebSocketRouteOptions;
    path: string;
}

Index

Properties

handlers options? path

Properties

`Readonly`handlers

handlers: WebSocketHandlers

The lifecycle callbacks, exactly as the imperative route() accepts.

`Optional` `Readonly`options

options?: WebSocketRouteOptions

Per-route configuration, including the route's upgrade guards.

`Readonly`path

path: string

The exact URL path to accept upgrades on (e.g. /ws/chat).