Creates an instance of StandaloneWebsocketRoute.
The method name for the route.
The configuration object for the object method.
The property key of the target object.
The target object.
Optional
modifiesAuthentication: booleanIndicates whether the route modifies authentication.
Protected
authenticatorProtected
childrenProtected
isProtected
methodProtected
objThe configuration object for the object method.
Returns the child routes of the current route.
Returns the decorated function with added authentication checks.
Returns the decorated function with added authentication checks.
Rest
...data: any[]Returns the method name for the route.
Sets the method name for the route.
The method name.
Checks if the decorated function has an authenticator.
Throws an error as child routes are not supported for standalone routes.
Protected
authenticateOptional
requestData: anyBinds the decorator configuration reference to the WebSocket route.
The decorator configuration reference.
Protected
callProtected
Calls the object method associated with the route and handles the response.
The WebSocket request.
Registers the outbound methods whose data is potentially modified during the execution of this route.
The outbound routes that are potentially modified.
Optional
filter: MessageFilterThe message filter.
Routes the WebSocket request based on the method name.
The WebSocket request.
The path to route.
Protected
routeProtected
Routes the WebSocket request to the children routes.
The WebSocket request.
The path to route.
Protected
sendProtected
Sends an error message to the WebSocket connection.
The WebSocket connection.
The error message.
Sets the authenticator for the decorated function.
The websocket authenticator.
Generated using TypeDoc
Represents a standalone WebSocket route that handles WebSocket requests independently. This way, routes without parent routes can be registered and are still allowed to contain
.
path separators.