Class QueryBus

Concrete query bus implementing IQueryBus.

Since

0.1.0

Implements

IQueryBus

Index

Constructors

Accessors

Methods

clear execute register setBehaviors

Constructors

constructor

new QueryBus(
behaviors?: readonly IPipelineBehavior<CqrsRequest<unknown>, unknown>[],
): QueryBus
Creates a new query bus.
Parameters
- behaviors: readonly IPipelineBehavior<CqrsRequest<unknown>, unknown>[] = []
  Behaviors to apply to every query execution (default: [])
Returns QueryBus
- Defined in packages/cqrs-plugin/src/bus/query-bus.ts:22

Accessors

handlerCount

get handlerCount(): number
The number of registered query handlers.

INTERNAL: not part of the IQueryBus interface.

Returns number
- Defined in packages/cqrs-plugin/src/bus/query-bus.ts:63

Methods

clear

clear(): void
Clears all registered query handlers.

INTERNAL: not part of the IQueryBus interface.

Returns void
- Defined in packages/cqrs-plugin/src/bus/query-bus.ts:72

execute

execute<TResult = unknown>(query: CqrsQuery): Promise<TResult>
Executes a query.
Type Parameters
- TResult = unknown
Parameters
- query: CqrsQuery
  The query to execute
Returns Promise<TResult>
The handler's result
Implementation of IQueryBus.execute
- Defined in packages/cqrs-plugin/src/bus/query-bus.ts:45

register

register<TQuery extends CqrsQuery<unknown>, TResult>(
type: string,
handler: IQueryHandler<TQuery, TResult>,
): void
Registers a query handler.
Type Parameters
- TQuery extends CqrsQuery<unknown>
- TResult
Parameters
- type: string
  The query type name
- handler: IQueryHandler<TQuery, TResult>
  The query handler
Returns void
Implementation of IQueryBus.register
- Defined in packages/cqrs-plugin/src/bus/query-bus.ts:32

setBehaviors

setBehaviors(
behaviors: readonly IPipelineBehavior<CqrsRequest<unknown>, unknown>[],
): void
Replaces the behavior list.

INTERNAL: not part of the IQueryBus interface.
Parameters
- behaviors: readonly IPipelineBehavior<CqrsRequest<unknown>, unknown>[]
Returns void
- Defined in packages/cqrs-plugin/src/bus/query-bus.ts:54