Class SimpleWebsocketRoute

Represents a simple WebSocket route that does not require a target/propertyKey configuration. This can be used to register a route for anonymous functions.

Hierarchy

Constructors

Properties

authenticator: WebsocketAuthenticator = null
children: WebsocketRoute[] = []
func: ((...data) => Promise<any>)

Type declaration

    • (...data): Promise<any>
    • The function to be called for the route.

      Parameters

      • Rest ...data: any[]

      Returns Promise<any>

isOutbound: boolean = false
method: string
objConfig: {
    propertyKey: string;
    target: any;
}

The configuration object for the object method.

Type declaration

  • propertyKey: string
  • target: any

Accessors

  • get Func(): ((...data) => any)
  • Returns the function associated with the route.

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

    • The function associated with the route.
      • (...data): any
      • Returns the function associated with the route.

        Parameters

        • Rest ...data: any[]

        Returns any

        • The function associated with the route.
  • get hasAuthenticator(): boolean
  • Checks if the decorated function has an authenticator.

    Returns boolean

    • Indicates whether the decorated function has an authenticator.

Methods

Generated using TypeDoc