Interface IQueryBus

Registers and executes queries.

Since

0.1.0

interface IQueryBus {
    execute<TResult = unknown>(query: CqrsQuery): Promise<TResult>;
    register<TQuery extends CqrsQuery<unknown>, TResult>(
        type: string,
        handler: IQueryHandler<TQuery, TResult>,
    ): void;
}

Implemented by

QueryBus

Index

Methods

execute register

Methods

execute

execute<TResult = unknown>(query: CqrsQuery): Promise<TResult>
Executes a query.
Type Parameters
- TResult = unknown
  The expected result type
Parameters
- query: CqrsQuery
  The query to execute
Returns Promise<TResult>
The handler's result

Throws
(from the plugin) — as a REJECTION — if no handler is registered for query.type

Throws
— as a REJECTION — if query.type is not a string
- Defined in packages/common/src/services/cqrs.ts:158

register

register<TQuery extends CqrsQuery<unknown>, TResult>(
type: string,
handler: IQueryHandler<TQuery, TResult>,
): void
Registers a handler for a query type.
Type Parameters
- TQuery extends CqrsQuery<unknown>
  The query type
- TResult
  The result type
Parameters
- type: string
  Query type name (must match query.type)
- handler: IQueryHandler<TQuery, TResult>
  The query handler
Returns void
- Defined in packages/common/src/services/cqrs.ts:143