Class HeaderHandler

Handler that sets custom headers on the response.

Hierarchy

HttpHandler
- HeaderHandler

Index

Constructors

constructor

Properties

headers

Methods

Constructors

constructor

new HeaderHandler(headers: Record<string, string>): HeaderHandler

Overrides HttpHandler.constructor
- Defined in src/server/middleware/HeaderHandler.ts:10
Parameters
- headers: Record<string, string>
Returns HeaderHandler

Properties

Private Readonly headers

headers: Record<string, string>

Methods

canHandle

canHandle(input: HttpHandlerInput): Promise<void>

Inherited from HttpHandler.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: HttpHandlerInput
  
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

handle

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

Overrides HttpHandler.handle
- Defined in src/server/middleware/HeaderHandler.ts:15
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- __namedParameters: { response: ServerResponse }
  - response: ServerResponse
Returns Promise<void>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: HttpHandlerInput): Promise<void>

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

Parameters
- input: HttpHandlerInput
  
  Input data that will be handled if it can be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.