diff --git a/src/node/wsRouter.ts b/src/node/wsRouter.ts index e1502c4fb..1ff13aafd 100644 --- a/src/node/wsRouter.ts +++ b/src/node/wsRouter.ts @@ -27,6 +27,10 @@ interface InternalWebsocketRequest extends pluginapi.WebsocketRequest { export class WebsocketRouter { public readonly router = express.Router() + /** + * Handle a websocket at this route. Note that websockets are immediately + * paused when they come in. + */ public ws(route: expressCore.PathParams, ...handlers: pluginapi.WebSocketHandler[]): void { this.router.get( route,