Class CommandRouterEventHandler<W, X>

Class representing a CommandRouterEventHandler. Responsible for finding and dispatching commands based on incoming events.

Author

Mr. Stone evensstone@gmail.com

Type Parameters

W extends IncomingEvent = IncomingEvent
X = unknown

Implements

IEventHandler<W, X>

Index

Constructors

Methods

dispatch findCommand handle runCommand create

Constructors

constructor

new CommandRouterEventHandler<
    W extends IncomingEvent = IncomingEvent,
    X = unknown,
>(
    container: CommandRouterEventHandlerOptions,
): CommandRouterEventHandler<W, X>
Create a new instance of CommandRouter.
Type Parameters
- W extends IncomingEvent = IncomingEvent
- X = unknown
Parameters
- container: CommandRouterEventHandlerOptions
  The container instance for dependency resolution.
Returns CommandRouterEventHandler<W, X>

Methods

dispatch

dispatch(event: W): Promise<X>
Dispatches an event to the appropriate command.
Parameters
- event: W
  The incoming event to be dispatched.
Returns Promise<X>
The result of the command execution.

findCommand

findCommand(event: W): ICommandHandler<W, X>
Finds a command that matches the given event.
Parameters
- event: W
  The incoming event to match against commands.
Returns ICommandHandler<W, X>
The matching command, or undefined if no match is found.

handle

handle(event: W): Promise<X>
Handle an incoming event.
Parameters
- event: W
  The incoming event to process.
Returns Promise<X>
The outgoing response.

Implementation of IEventHandler.handle

runCommand

runCommand(event: W, command?: ICommandHandler<W, X>): Promise<X>
Runs the given command with the provided event.
Parameters
- event: W
  The event to handle.
- Optionalcommand: ICommandHandler<W, X>
  The command to execute.
Returns Promise<X>
The result of the command execution, or void if no command is found.

`Static`create

create<
    W extends IncomingEvent = IncomingEvent,
    X extends OutgoingResponse = OutgoingResponse,
>(
    options: CommandRouterEventHandlerOptions,
): CommandRouterEventHandler<W, X>
Creates a new instance of CommandRouter.

This static method initializes a CommandRouter with the specified options.
Type Parameters
- W extends IncomingEvent = IncomingEvent
  The type of the incoming event (default: IncomingEvent).
- X extends OutgoingResponse = OutgoingResponse
  The type of the outgoing response (default: OutgoingResponse).
Parameters
- options: CommandRouterEventHandlerOptions
  The configuration options for the CommandRouter.
Returns CommandRouterEventHandler<W, X>
A new instance of CommandRouter configured with the provided options.