Class RouterHandler

An HttpHandler that checks if a given method and path are satisfied and allows its handler to be executed if so.

Hierarchy

HttpHandler
- RouterHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RouterHandler(handler: HttpHandler, allowedMethods: string[], allowedPathNames: string[]): RouterHandler

Overrides HttpHandler.constructor
- Defined in src/server/util/RouterHandler.ts:14
Parameters
- handler: HttpHandler
- allowedMethods: string[]
- allowedPathNames: string[]
Returns RouterHandler

Properties

Protected Readonly allowedMethods

allowedMethods: string[]

Protected Readonly allowedPathNamesRegEx

allowedPathNamesRegEx: RegExp[]

Protected Readonly handler

handler: HttpHandler

Methods

canHandle

canHandle(input: HttpHandlerInput): Promise<void>

Overrides HttpHandler.canHandle
- Defined in src/server/util/RouterHandler.ts:23
Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

Parameters
- input: HttpHandlerInput
Returns Promise<void>

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

handle

handle(input: HttpHandlerInput): Promise<void>

Overrides HttpHandler.handle
- Defined in src/server/util/RouterHandler.ts:43
Handles the given input. This should only be done if the canHandle function returned true. Therefore, consider using the handleSafe function instead.

Parameters
- input: HttpHandlerInput
Returns Promise<void>

A promise resolving when the handling is finished. Return value depends on the given type.

handleSafe

handleSafe(input: HttpHandlerInput): Promise<void>

Inherited from HttpHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:35
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
- 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. Return value depends on the given type.