Class ParallelHandler<TIn, TOut>

A composite handler that executes handlers in parallel.

Type parameters

TIn = void
TOut = void

Hierarchy

AsyncHandler<TIn, TOut[]>
- ParallelHandler

Index

Constructors

constructor

Properties

handlers

Methods

Constructors

constructor

new ParallelHandler<TIn, TOut>(handlers: AsyncHandler<TIn, TOut>[]): ParallelHandler<TIn, TOut>

Overrides AsyncHandler.constructor
- Defined in src/util/handlers/ParallelHandler.ts:9
Type parameters
- TIn = void
- TOut = void
Parameters
- handlers: AsyncHandler<TIn, TOut>[]
Returns ParallelHandler<TIn, TOut>

Properties

Private Readonly handlers

handlers: AsyncHandler<TIn, TOut>[]

Methods

canHandle

canHandle(input: TIn): Promise<void>

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

Parameters
- input: TIn
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(input: TIn): Promise<TOut[]>

Overrides AsyncHandler.handle
- Defined in src/util/handlers/ParallelHandler.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.

Parameters
- input: TIn
Returns Promise<TOut[]>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: TIn): Promise<TOut[]>

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: TIn
  Input data that will be handled if it can be handled.
Returns Promise<TOut[]>
A promise resolving if the input can be handled, rejecting with an Error if not.