Class WebsocketRequestContext

The context of an incoming websocket request.

Hierarchy (View Summary)

BaseContext<"websocket-request">
- WebsocketRequestContext

Index

Constructors

Properties

connection controllerClass controllerMethod request type

Methods

Constructors

constructor

new WebsocketRequestContext(
    request: WebsocketRequest,
    connection: BaseWebsocketConnection | undefined,
    controllerClass: Newable<unknown> | undefined,
    controllerMethod: string | undefined,
): WebsocketRequestContext
Parameters
- request: WebsocketRequest
- connection: BaseWebsocketConnection | undefined
- controllerClass: Newable<unknown> | undefined
- controllerMethod: string | undefined
Returns WebsocketRequestContext
Overrides BaseContext.constructor
- Defined in src/context/request/websocket-request.context.ts:14

Properties

`Readonly`connection

connection: BaseWebsocketConnection | undefined

`Readonly`controllerClass

controllerClass: Newable<unknown> | undefined

`Readonly`controllerMethod

controllerMethod: string | undefined

`Readonly`request

request: WebsocketRequest

`Readonly`type

type: "websocket-request" = 'websocket-request'

Methods

get

get<T>(token: RequestContextToken<T>): T
Either returns the cached value for the given token or initializes and caches a new value.
Type Parameters
- T
Parameters
- token: RequestContextToken<T>
  The token to get the value of.
Returns T
Either the cached or a new value.
- Defined in src/context/request/websocket-request.context.ts:37

has

has<T>(token: RequestContextToken<T>): boolean
Whether or not a value for the given token has been cached.
Type Parameters
- T
Parameters
- token: RequestContextToken<T>
  The token to check.
Returns boolean
True if a value has been cached, false otherwise.
- Defined in src/context/request/websocket-request.context.ts:28