Class UnsupportedAsyncHandler

Handler that does not support any input and will always throw an error.

Hierarchy

AsyncHandler<any, never>
- UnsupportedAsyncHandler

Index

Constructors

constructor

Properties

errorMessage

Methods

Constructors

constructor

new UnsupportedAsyncHandler(errorMessage?: string): UnsupportedAsyncHandler

Overrides AsyncHandler.constructor
- Defined in src/util/handlers/UnsupportedAsyncHandler.ts:10
Parameters
- Optional errorMessage: string
Returns UnsupportedAsyncHandler

Properties

Private Optional Readonly errorMessage

errorMessage?: string

Methods

canHandle

canHandle(): Promise<never>

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

Returns Promise<never>
A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(): Promise<never>

Overrides AsyncHandler.handle
- Defined in src/util/handlers/UnsupportedAsyncHandler.ts:19
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<never>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: any): Promise<never>

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<never>
A promise resolving if the input can be handled, rejecting with an Error if not.