Class WebsocketRouter

WebsocketRouter class handles routing for websocket requests.

Hierarchy

WebsocketRouter

Index

Constructors

Properties

routes standaloneRoutes

Accessors

Routes StandaloneRoutes

Methods

route getRouteByMethod loadDecoratorConfig registerRoute registerStandaloneRoute removeRouteIfExists

Constructors

constructor

new WebsocketRouter(): WebsocketRouter
Returns WebsocketRouter

Properties

`Static` `Private` routes

routes: WebsocketRoute[] = []

`Static` `Private` standaloneRoutes

standaloneRoutes: StandaloneWebsocketRoute[] = []

Accessors

`Static` Routes

get Routes(): WebsocketRoute[]
Get all registered routes.

Returns WebsocketRoute[]
- An array of websocket routes.
- Defined in src/websocket/server/routing/router.ts:75

`Static` StandaloneRoutes

get StandaloneRoutes(): StandaloneWebsocketRoute[]
Get all registered standalone routes.

Returns StandaloneWebsocketRoute[]
- An array of standalone websocket routes.
- Defined in src/websocket/server/routing/router.ts:83

Methods

route

route(request): Promise<any>
Route a websocket request.
Parameters
- request: WebsocketRequest
  
  The websocket request to route.
Returns Promise<any>
- A promise that resolves with the routed response.
- Defined in src/websocket/server/routing/router.ts:123

`Static` getRouteByMethod

getRouteByMethod(method): WebsocketRoute
Get a route by its method.
Parameters
- method: string
  
  The method to search for.
Returns WebsocketRoute
- The matching websocket route.
Throws
- If no route is found with the given method.
- Defined in src/websocket/server/routing/router.ts:93

`Static` loadDecoratorConfig

loadDecoratorConfig(): void
Loads the decorator configuration for all WebSocket routes. Iterates through each route and invokes the loadDecoratorConfig method to load the configuration.

Returns void
- Defined in src/websocket/server/routing/router.ts:132

`Static` registerRoute

registerRoute(route): void
Register a route.
Parameters
- route: WebsocketRoute
  
  The websocket route to register.
Returns void
- Defined in src/websocket/server/routing/router.ts:36

`Static` registerStandaloneRoute

registerStandaloneRoute(route): void
Register a standalone route.
Parameters
- route: StandaloneWebsocketRoute
  
  The standalone websocket route to register.
Returns void
- Defined in src/websocket/server/routing/router.ts:15

`Static` removeRouteIfExists

removeRouteIfExists(method): void
Removes a WebSocket route if it exists.
Parameters
- method: string
  
  The method name of the route to remove.
Returns void
- Defined in src/websocket/server/routing/router.ts:45

Generated using TypeDoc