Interface CommandBus

Bus for dispatching commands to their handlers.

Ensures that each command is handled by exactly one handler.

Example

// Register handler
commandBus.register(CreateUserCommand, new CreateUserCommandHandler());

// Dispatch command
const user = await commandBus.dispatch<User>(
  new CreateUserCommand('user@example.com', 'John Doe')
);
interface CommandBus {
    register<TCommand extends Command, TResult = void>(
        commandType: new (...args: unknown[]) => TCommand,
        handler: CommandHandler<TCommand, TResult>,
    ): void;
    dispatch<TResult = void>(command: Command): Promise<TResult>;
}

Methods

register dispatch

Methods

register

dispatch

  • dispatch<TResult = void>(command: Command): Promise<TResult>

    Dispatches a command to its registered handler.

    Type Parameters

    • TResult = void

      The expected result type

    Parameters

    • command: Command

      The command to dispatch

    Returns Promise<TResult>

    The result from the command handler

    Throws

    Error if no handler is registered for the command

    Example

    const command = new CreateUserCommand('user@example.com', 'John');
    const user = await commandBus.dispatch<User>(command);

Settings

Member Visibility

On This Page

Methods