Interface CommandBus

Service for registering and executing commands

Hierarchy

CommandHandler
- CommandBus

Index

Methods

createCommand getHandler handle isSupported register

Methods

createCommand

createCommand<T>(config: CommandConfig<T>): T
Create a command instance from a CommandConfig

Throws
Thrown if the command has not been registered yet
Type Parameters
- T = any
Parameters
- config: CommandConfig<T>
  
  The command configuration
Returns T

getHandler

getHandler(commandClass: CommandClass): CommandHandler
Get a handler associated with a command

Returns
the handler for the command class
Parameters
- commandClass: CommandClass
  
  The command class
Returns CommandHandler

handle

handle(command: object): any
Execute the given command with it's registered command handler

Returns
result from the command handler
Parameters
- command: object
  
  command to execute
Returns any

Overrides CommandHandler.handle

isSupported

isSupported(commandId: CommandIdentifier): boolean
Check if a command is supported

Returns
true if the command is supported, false otherwise
Parameters
- commandId: CommandIdentifier
  
  identifier of the command. Can be either the class or the string the class was registered with
Returns boolean

register

register(commandClass: CommandClass, handler: CommandHandler): void
Register a command to be executed by the given handler
Parameters
- commandClass: CommandClass
  
  type of command
- handler: CommandHandler
  
  the handler instance used to execute the command
Returns void