Class WebSocketAdvertiser

Handler that advertises a WebSocket through the Updates-Via header.

Hierarchy

HttpHandler
- WebSocketAdvertiser

Index

Constructors

constructor

Properties

socketUrl

Methods

Constructors

constructor

new WebSocketAdvertiser(baseUrl: string): WebSocketAdvertiser

Inherited from HttpHandler.constructor
- Defined in src/server/middleware/WebSocketAdvertiser.ts:9
Parameters
- baseUrl: string
Returns WebSocketAdvertiser

Properties

Private Readonly socketUrl

socketUrl: string

Methods

canHandle

canHandle(input: { request: HttpRequest; response: HttpResponse }): Promise<void>

Inherited from HttpHandler.canHandle
- Defined in src/util/AsyncHandler.ts:13
Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

Parameters
- input: { request: HttpRequest; response: HttpResponse }
  
  Input data that would be handled potentially.
  - request: HttpRequest
  - response: HttpResponse
Returns Promise<void>

A promise resolving if this input can be handled, rejecting with an Error if not.

handle

handle(__namedParameters: { response: HttpResponse }): Promise<void>

Overrides HttpHandler.handle
- Defined in src/server/middleware/WebSocketAdvertiser.ts:18
Parameters
- __namedParameters: { response: HttpResponse }
  - response: HttpResponse
Returns Promise<void>

handleSafe

handleSafe(data: { request: HttpRequest; response: HttpResponse }): Promise<void>

Inherited from HttpHandler.handleSafe
- Defined in src/util/AsyncHandler.ts:33
Helper function that first runs the canHandle function followed by the handle function. Throws the error of the canHandle function if the data can't be handled, or returns the result of the handle function otherwise.

Parameters
- data: { request: HttpRequest; response: HttpResponse }
  
  The data to handle.
  - request: HttpRequest
  - response: HttpResponse
Returns Promise<void>

The result of the handle function of the handler.