Interface CommandBus

An event bus is a Point-to-Point Channel transferring Command.

Hierarchy

Disposable
- CommandBus

Index

Methods

Methods

dispose

dispose(): Promise<void>

Inherited from Disposable.dispose
- Defined in packages/ceb-messaging-core/src/common.ts:18
Release all stateful stuff.

Returns Promise<void>

execute

execute<R, C>(command: C, options?: Partial<ExecuteActionOptions>): Promise<R>

- Defined in packages/ceb-messaging-core/src/command.ts:100
Execute a command and wait for a result.

Type parameters
- R: Result<any, ResultHeaders, R> = Result<any, ResultHeaders>
  
  the type of the result
- C: Command<any, MessageHeaders, C> = Command<any, MessageHeaders>
  
  the type of the command
Parameters
- command: C
  
  the command
- Optional options: Partial<ExecuteActionOptions>
  
  the options
Returns Promise<R>

executeAndForget

executeAndForget<C>(command: C): void

- Defined in packages/ceb-messaging-core/src/command.ts:110
Execute a command but forget the result.

Type parameters
- C: Command<any, MessageHeaders, C> = Command<any, MessageHeaders>
  
  the type of the command
Parameters
- command: C
  
  the command
Returns void

handle

handle<C, R, Es>(commandType: string, handler: CommandHandler<C, R, Es>): Removable

- Defined in packages/ceb-messaging-core/src/command.ts:120
Register a command handler.

Type parameters
- C: Command<any, MessageHeaders, C> = Command<any, MessageHeaders>
  
  the type of the command
- R: Result<any, ResultHeaders, R> = Result<any, ResultHeaders>
  
  the type of the result
- Es: Event<any, MessageHeaders>[] = []
  
  the type of the events
Parameters
- commandType: string
  
  the type of the command
- handler: CommandHandler<C, R, Es>
  
  the handler
Returns Removable

Generated using TypeDoc