Class CorsHandler

Handler that sets CORS options on the response.

Hierarchy

HttpHandler
- CorsHandler

Index

Constructors

constructor

Properties

corsHandler

Methods

Constructors

constructor

new CorsHandler(options?: SimpleCorsOptions): CorsHandler

Inherited from HttpHandler.constructor
- Defined in src/server/middleware/CorsHandler.ts:27
Parameters
- options: SimpleCorsOptions = ...
Returns CorsHandler

Properties

Private Readonly corsHandler

corsHandler: RequestHandler

Methods

canHandle

canHandle(input: HttpHandlerInput): 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: HttpHandlerInput
  
  Input data that would be handled potentially.
Returns Promise<void>

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

handle

handle(input: HttpHandlerInput): Promise<void>

Overrides HttpHandler.handle
- Defined in src/server/middleware/CorsHandler.ts:34
Parameters
- input: HttpHandlerInput
Returns Promise<void>

handleSafe

handleSafe(data: HttpHandlerInput): 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: HttpHandlerInput
  
  The data to handle.
Returns Promise<void>

The result of the handle function of the handler.