Class StaticHandler<T>

A handler that always resolves and always returns the stored value. Will return undefined if no value is stored.

The generic type extends any due to Components.js requirements.

Type parameters

T: any = void

Hierarchy

AsyncHandler<any, T>
- StaticHandler

Index

Constructors

constructor

Properties

value

Methods

Constructors

constructor

new StaticHandler<T>(value?: T): StaticHandler<T>

Overrides AsyncHandler.constructor
- Defined in src/util/handlers/StaticHandler.ts:13
Type parameters
- T: unknown = void
Parameters
- Optional value: T
Returns StaticHandler<T>

Properties

Private Optional Readonly value

value?: T

Methods

canHandle

canHandle(input: any): Promise<void>

Inherited from AsyncHandler.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: any
  
  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(): Promise<T>

Overrides AsyncHandler.handle
- Defined in src/util/handlers/StaticHandler.ts:18
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Returns Promise<T>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: any): Promise<T>

Inherited from AsyncHandler.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: any
  
  Input data that will be handled if it can be handled.
Returns Promise<T>
A promise resolving if the input can be handled, rejecting with an Error if not.