Class WsRouteTable

The registered WebSocket routes.

Since

0.1.0

Index

Constructors

Accessors

Methods

Constructors

constructor

new WsRouteTable(): WsRouteTable

Returns WsRouteTable

Accessors

size

get size(): number
Number of registered routes.

Returns number
- Defined in packages/websocket-plugin/src/routing/ws-route-table.ts:97

Methods

add

add(
    path: string,
    handlers: WebSocketHandlers,
    options?: WebSocketRouteOptions,
): void
Registers a route.
Parameters
- path: string
  The exact path to serve
- handlers: WebSocketHandlers
  The lifecycle callbacks
- Optionaloptions: WebSocketRouteOptions
  Per-route configuration
Returns void

Throws
If the path is already registered
- Defined in packages/websocket-plugin/src/routing/ws-route-table.ts:109

match

match(request: Request): WsRouteMatch | null
Matches an upgrade request.
Parameters
- request: Request
  The upgrade request
Returns WsRouteMatch | null
The match, or a refusal with the status to answer

Since
0.1.0
- Defined in packages/websocket-plugin/src/routing/ws-route-table.ts:128