Class InMemoryCommandBus

In-memory command bus implementation.

Provides a simple, synchronous command bus for handling commands. Each command type can have only one handler.

Example

const commandBus = new InMemoryCommandBus();

// Register handler
commandBus.register(CreateUserCommand, async (cmd) => {
  const user = await userRepository.create(cmd.email, cmd.name);
  return user.id;
});

// Dispatch command
const userId = await commandBus.dispatch(new CreateUserCommand('john@example.com', 'John'));

Implements

  • CommandBus

Constructors

constructor

Methods

register dispatch hasHandler unregister clear

Constructors

constructor

Methods

register

  • register<TCommand extends Command, TResult = void>(
        commandType: new (...args: never[]) => TCommand,
        handler:
            | CommandHandler<TCommand, TResult>
            | (command: TCommand) => Promise<TResult>,
    ): void

    Registers a command handler.

    Type Parameters

    • TCommand extends Command

      The command type

    • TResult = void

      The result type

    Parameters

    Returns void

    Throws

    If a handler is already registered for this command type

    Example

    commandBus.register(CreateUserCommand, async (cmd) => {
      return await createUser(cmd.email, cmd.name);
    });

dispatch

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

    Dispatches a command to its registered handler.

    Type Parameters

    • TResult = void

      The result type

    Parameters

    • command: Command

      The command to dispatch

    Returns Promise<TResult>

    The result from the command handler

    Throws

    If no handler is registered for this command type

    Example

    const result = await commandBus.dispatch(new CreateUserCommand('john@example.com', 'John'));

hasHandler

  • hasHandler(commandType: new (...args: never[]) => Command): boolean

    Checks if a handler is registered for a command type.

    Parameters

    • commandType: new (...args: never[]) => Command

      The command class constructor

    Returns boolean

    True if a handler is registered

unregister

  • unregister(commandType: new (...args: never[]) => Command): boolean

    Unregisters a command handler.

    Parameters

    • commandType: new (...args: never[]) => Command

      The command class constructor

    Returns boolean

    True if a handler was unregistered

clear

Settings

Member Visibility

On This Page

Constructors
Methods