Class AuthableDecorableFunction`Abstract`

Represents the reference to an object method used for websocket routes and outbounds with support for authentication.

Hierarchy

DecorableFunction
- AuthableDecorableFunction

Index

Constructors

Properties

authenticator isOutbound objConfig

Accessors

Func hasAuthenticator

Methods

authenticateOrThrow sendError setAuthenticator

Constructors

constructor

new AuthableDecorableFunction(objConfig): AuthableDecorableFunction
Creates an instance of DecorableFunction.
Parameters
- 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.
Returns AuthableDecorableFunction
Inherited from DecorableFunction.constructor
- Defined in src/decorator-config/function.ts:14

Properties

`Protected` authenticator

authenticator: WebsocketAuthenticator = null

`Protected` isOutbound

isOutbound: boolean = false

`Protected` objConfig

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

The configuration object for the object method.

Type declaration

propertyKey: string
target: any

Accessors

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.
Overrides DecorableFunction.Func
- Defined in src/decorator-config/function.ts:82

hasAuthenticator

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

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

Methods

`Protected` authenticateOrThrow

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

`Protected` `Abstract` sendError

sendError(conn, message, authError?): void
Protected
Sends an error message through the websocket connection.
Parameters
- conn: WebsocketConnection
  
  The websocket connection.
- message: string
  
  The error message.
- Optional authError: boolean
Returns void
- Defined in src/decorator-config/function.ts:125

setAuthenticator

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

Generated using TypeDoc