Class StaticAssetHandler

Handler that serves static resources on specific paths.

Hierarchy

HttpHandler
- StaticAssetHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StaticAssetHandler(assets: Record<string, string>): StaticAssetHandler

Inherited from HttpHandler.constructor
- Defined in src/server/middleware/StaticAssetHandler.ts:20
Creates a handler for the provided static resources.

Parameters
- assets: Record<string, string>
  
  A mapping from URL paths to paths, where URL paths ending in a slash are interpreted as entire folders.
Returns StaticAssetHandler

Properties

Private Readonly logger

logger: Logger = ...

Private Readonly mappings

mappings: Record<string, string>

Private Readonly pathMatcher

pathMatcher: RegExp

Methods

canHandle

canHandle(__namedParameters: HttpHandlerInput): Promise<void>

Overrides HttpHandler.canHandle
- Defined in src/server/middleware/StaticAssetHandler.ts:69
Parameters
- __namedParameters: HttpHandlerInput
Returns Promise<void>

Private createPathMatcher

createPathMatcher(assets: Record<string, string>): RegExp

- Defined in src/server/middleware/StaticAssetHandler.ts:36
Creates a regular expression that matches the URL paths.

Parameters
- assets: Record<string, string>
Returns RegExp

Private getFilePath

getFilePath(__namedParameters: Guarded<IncomingMessage>): string

- Defined in src/server/middleware/StaticAssetHandler.ts:55
Obtains the file path corresponding to the asset URL

Parameters
- __namedParameters: Guarded<IncomingMessage>
Returns string

handle

handle(__namedParameters: HttpHandlerInput): Promise<void>

Overrides HttpHandler.handle
- Defined in src/server/middleware/StaticAssetHandler.ts:76
Parameters
- __namedParameters: HttpHandlerInput
Returns Promise<void>

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.