Interface ICommandBus

Registers and executes commands.

Since

0.1.0

interface ICommandBus {
    execute<TResult = unknown>(command: CqrsCommand): Promise<TResult>;
    register<TCommand extends CqrsCommand<unknown>, TResult>(
        type: string,
        handler: ICommandHandler<TCommand, TResult>,
    ): void;
}

Implemented by

CommandBus

Index

Methods

execute register

Methods

execute

execute<TResult = unknown>(command: CqrsCommand): Promise<TResult>
Executes a command.
Type Parameters
- TResult = unknown
  The expected result type
Parameters
- command: CqrsCommand
  The command to execute
Returns Promise<TResult>
The handler's result

Throws
(from the plugin) — as a REJECTION — if no handler is registered for command.type

Throws
— as a REJECTION — if command.type is not a string
- Defined in packages/common/src/services/cqrs.ts:126

register

register<TCommand extends CqrsCommand<unknown>, TResult>(
type: string,
handler: ICommandHandler<TCommand, TResult>,
): void
Registers a handler for a command type.
Type Parameters
- TCommand extends CqrsCommand<unknown>
  The command type
- TResult
  The result type
Parameters
- type: string
  Command type name (must match command.type)
- handler: ICommandHandler<TCommand, TResult>
  The command handler
Returns void
- Defined in packages/common/src/services/cqrs.ts:111