Interface QueryBus

Hierarchy

Disposable
- QueryBus

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, Q>(query: Q, options?: Partial<ExecuteActionOptions>): Promise<R>

- Defined in packages/ceb-messaging-core/src/query.ts:62
Execute a query and wait for the result.

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

handle

handle<Q, R>(queryType: string, handler: QueryHandler<Q, R>): Removable

- Defined in packages/ceb-messaging-core/src/query.ts:74
Register a query handler.

Type parameters
- Q: Query<any, MessageHeaders, Q> = Query<any, MessageHeaders>
  
  the type of the query
- R: Result<any, ResultHeaders, R> = Result<any, ResultHeaders>
  
  the type of the result
Parameters
- queryType: string
  
  the type of the query
- handler: QueryHandler<Q, R>
  
  the handler
Returns Removable

Generated using TypeDoc