Class RouterHandler

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

If allowedMethods contains '*' it will match all methods.

Hierarchy

HttpHandler
- RouterHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RouterHandler(args: RouterHandlerArgs): RouterHandler

Overrides HttpHandler.constructor
- Defined in src/server/util/RouterHandler.ts:31
Parameters
- args: RouterHandlerArgs
Returns RouterHandler

Properties

Private Readonly allMethods

allMethods: boolean

Private Readonly allowedMethods

allowedMethods: string[]

Private Readonly allowedPathNamesRegEx

allowedPathNamesRegEx: RegExp[]

Private Readonly baseUrl

baseUrl: string

Private Readonly handler

handler: HttpHandler

Private Readonly targetExtractor

targetExtractor: TargetExtractor

Methods

canHandle

canHandle(input: HttpHandlerInput): Promise<void>

Overrides HttpHandler.canHandle
- Defined in src/server/util/RouterHandler.ts:41
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
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:59
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- input: HttpHandlerInput
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.