Class WebsocketRoute

Represents a WebSocket route that can be used for routing and handling WebSocket requests.

Hierarchy

AuthableDecorableFunction
- WebsocketRoute
  - StandaloneWebsocketRoute

Constructors

constructor

new WebsocketRoute(method, objConfig, modifiesAuthentication?): WebsocketRoute
Creates an instance of WebsocketRoute.
Parameters
- method: string
  
  The method name for the route.
- objConfig: {
  propertyKey: string;
  target: any;
  }
  
  The configuration object for the object method.
  - propertyKey: string
    
    The property key of the target object.
  - target: any
    
    The target object.
- Optional modifiesAuthentication: boolean
  
  Indicates whether the route modifies authentication.
Returns WebsocketRoute
Overrides AuthableDecorableFunction.constructor
- Defined in src/websocket/server/routing/route.ts:27

Properties

`Protected` authenticator

authenticator: WebsocketAuthenticator = null

`Protected` children

children: WebsocketRoute[] = []

`Private` decoratorConfigReference

decoratorConfigReference: WebsocketRouteDecoratorConfig

`Protected` isOutbound

isOutbound: boolean = false

`Protected` method

method: string

`Private` `Optional` modifiesAuthentication

modifiesAuthentication?: boolean

Indicates whether the route modifies authentication.

`Private` modifiesOutbounds

modifiesOutbounds: {
filter: MessageFilter;
outboundRoutes: string[];
}[] = []

Type declaration

filter: MessageFilter
outboundRoutes: string[]

`Protected` objConfig

objConfig: {
propertyKey: string;
target: any;
}

The configuration object for the object method.

Type declaration

propertyKey: string
target: any

Accessors

Children

get Children(): WebsocketRoute[]
Returns the child routes of the current route.

Returns WebsocketRoute[]
- The child routes.
- Defined in src/websocket/server/routing/route.ts:81

Func

get Func(): ((...data) => any)
Returns the decorated function with added authentication checks.

Returns ((...data) => any)
- The decorated function.
- - (...data): any
  - Returns the decorated function with added authentication checks.
    Parameters
    - Rest ...data: any[]
    Returns any
    - The decorated function.
Inherited from AuthableDecorableFunction.Func
- Defined in src/decorator-config/function.ts:82

Method

get Method(): string
Returns the method name for the route.

Returns string
- The method name.
- Defined in src/websocket/server/routing/route.ts:40
set Method(method): void
Sets the method name for the route.
Parameters
- method: string
  
  The method name.
Returns void
Throws
- If the method contains a separator ".".
- Defined in src/websocket/server/routing/route.ts:49

hasAuthenticator

get hasAuthenticator(): boolean
Checks if the decorated function has an authenticator.

Returns boolean
- Indicates whether the decorated function has an authenticator.
Inherited from AuthableDecorableFunction.hasAuthenticator
- Defined in src/decorator-config/function.ts:115

Methods

addChild

addChild(child): void
Adds a child route to the current route.
Parameters
- child: WebsocketRoute
  
  The child route to add.
Returns void
- Defined in src/websocket/server/routing/route.ts:89

`Protected` authenticateOrThrow

authenticateOrThrow(conn, requestData?): Promise<void>
Parameters
- conn: WebsocketConnection
- Optional requestData: any
Returns Promise<void>
Inherited from AuthableDecorableFunction.authenticateOrThrow
- Defined in src/decorator-config/function.ts:101

bindDecoratorConfig

bindDecoratorConfig(reference): WebsocketRoute
Binds the decorator configuration reference to the WebSocket route.
Parameters
- reference: WebsocketRouteDecoratorConfig
  
  The decorator configuration reference.
Returns WebsocketRoute
- The WebSocket route instance.
- Defined in src/websocket/server/routing/route.ts:258

`Protected` call

call(request): Promise<any>
Protected
Calls the object method associated with the route and handles the response.
Parameters
- request: WebsocketRequest
  
  The WebSocket request.
Returns Promise<any>
- The response of the object method.
Throws
- If the object method is not defined for the route.
- Defined in src/websocket/server/routing/route.ts:167

`Private` checkForDuplicateChild

checkForDuplicateChild(child): void
Parameters
- child: WebsocketRoute
Returns void
- Defined in src/websocket/server/routing/route.ts:94

checkForDuplicates

checkForDuplicates(method?): void
Checks for duplicate routes with the same method.
Parameters
- Optional method: string
  
  The method name to check.
Returns void
- Defined in src/websocket/server/routing/route.ts:296

clearModifies

clearModifies(): void
Returns void
- Defined in src/websocket/server/routing/route.ts:71

`Private` handleError

handleError(e, req): void
Parameters
- e: any
- req: WebsocketRequest
Returns void
- Defined in src/websocket/server/routing/route.ts:190

loadDecoratorConfig

loadDecoratorConfig(): void
Loads the decorator configuration from the bound reference. Recursively initializes loading for all child routes.

Returns void
- Defined in src/websocket/server/routing/route.ts:267

modifies

modifies(outboundRoutes, filter?): void
Registers the outbound methods whose data is potentially modified during the execution of this route.
Parameters
- outboundRoutes: string[]
  
  The outbound routes that are potentially modified.
- Optional filter: MessageFilter
  
  The message filter.
Returns void
- Defined in src/websocket/server/routing/route.ts:67

`Private` resendModifiedData

resendModifiedData(responseData, requestConn): Promise<void>
Private
Triggers the execution of resending processes of updated data.
Parameters
- responseData: any
  
  The response data from the original call. It can be used within filter methods.
- requestConn: WebsocketConnection
  
  The WebSocket connection.
Returns Promise<void>
- Defined in src/websocket/server/routing/route.ts:215

route

route(request, path): Promise<boolean>
Routes the WebSocket request based on the provided path. Sends error message to the connection if the route call fails.
Parameters
- request: WebsocketRequest
  
  The WebSocket request.
- path: string[]
  
  The path to route.
Returns Promise<boolean>
- Indicates whether the routing was successful.
- Defined in src/websocket/server/routing/route.ts:113

`Protected` routeChildren

routeChildren(request, path): Promise<boolean>
Protected
Routes the WebSocket request to the children routes.
Parameters
- request: WebsocketRequest
  
  The WebSocket request.
- path: string[]
  
  The path to route.
Returns Promise<boolean>
- Indicates whether the routing was successful.
- Defined in src/websocket/server/routing/route.ts:148

`Protected` sendError

sendError(conn, message): void
Protected
Sends an error message to the WebSocket connection.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection.
- message: string
  
  The error message.
Returns void
Overrides AuthableDecorableFunction.sendError
- Defined in src/websocket/server/routing/route.ts:247

setAuthenticator

setAuthenticator(authenticator): void
Sets the authenticator for the decorated function.
Parameters
- authenticator: WebsocketAuthenticator
  
  The websocket authenticator.
Returns void
Inherited from AuthableDecorableFunction.setAuthenticator
- Defined in src/decorator-config/function.ts:74

Class WebsocketRoute

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

method: string

objConfig: { propertyKey: string; target: any; }

propertyKey: string

target: any

Optional modifiesAuthentication: boolean

Returns WebsocketRoute

Properties

Protected authenticator

Protected children

Private decoratorConfigReference

Protected isOutbound

Protected method

Private Optional modifiesAuthentication

Private modifiesOutbounds

Type declaration

filter: MessageFilter

outboundRoutes: string[]

Protected objConfig

Type declaration

propertyKey: string

target: any

Accessors

Children

Returns WebsocketRoute[]

Func

Returns ((...data) => any)

Parameters

Rest ...data: any[]

Returns any

Method

Returns string

Parameters

method: string

Returns void

Throws

hasAuthenticator

Returns boolean

Methods

addChild

Parameters

child: WebsocketRoute

Returns void

Protected authenticateOrThrow

Parameters

conn: WebsocketConnection

Optional requestData: any

Returns Promise<void>

bindDecoratorConfig

Parameters

reference: WebsocketRouteDecoratorConfig

Returns WebsocketRoute

Protected call

Parameters

request: WebsocketRequest

Returns Promise<any>

Throws

Private checkForDuplicateChild

Parameters

child: WebsocketRoute

Returns void

checkForDuplicates

Parameters

Optional method: string

Returns void

clearModifies

Returns void

Private handleError

Parameters

e: any

req: WebsocketRequest

objConfig: {
propertyKey: string;
target: any;
}

`Optional` modifiesAuthentication: boolean

`Protected` authenticator

`Protected` children

`Private` decoratorConfigReference

`Protected` isOutbound

`Protected` method

`Private` `Optional` modifiesAuthentication

`Private` modifiesOutbounds

`Protected` objConfig

`Rest` ...data: any[]

`Protected` authenticateOrThrow

`Optional` requestData: any

`Protected` call

`Private` checkForDuplicateChild

`Optional` method: string

`Private` handleError

`Optional` filter: MessageFilter

`Private` resendModifiedData

`Protected` routeChildren

`Protected` sendError