Interface UseCaseEventHelpers<Emits>

Event helper scoped to the events declared by a use case.

interface UseCaseEventHelpers<Emits extends readonly DomainEventLike[]> {
    declared: Emits;
    assertDeclared(event: DomainEventLike): void;
    isDeclared(event: DomainEventLike): boolean;
    publish<E extends DomainEventLike>(
        eventBus: UseCaseEventBusTarget,
        event: E,
        payload: InferUseCaseEventPayload<E>,
    ): Promise<void>;
    record<E extends DomainEventLike>(
        recorder: UseCaseEventRecorderTarget,
        event: E,
        payload: InferUseCaseEventPayload<E>,
    ): Promise<void>;
}

Type Parameters

Emits extends readonly DomainEventLike[]

Index

Properties

Methods

assertDeclared isDeclared publish record

Properties

`Readonly`declared

declared: Emits

The exact event definitions declared with .emits(...).

Methods

assertDeclared

assertDeclared(event: DomainEventLike): void
Throw if an event is not declared by this use case.
Parameters
- event: DomainEventLike
Returns void
- Defined in packages/core/src/application/index.ts:211

isDeclared

isDeclared(event: DomainEventLike): boolean
Return whether an event is declared by this use case.
Parameters
- event: DomainEventLike
Returns boolean
- Defined in packages/core/src/application/index.ts:206

publish

publish<E extends DomainEventLike>(
    eventBus: UseCaseEventBusTarget,
    event: E,
    payload: InferUseCaseEventPayload<E>,
): Promise<void>
Validate and publish a declared event directly through an event bus.
Type Parameters
- E extends DomainEventLike
Parameters
- eventBus: UseCaseEventBusTarget
- event: E
- payload: InferUseCaseEventPayload<E>
Returns Promise<void>
- Defined in packages/core/src/application/index.ts:225

record

record<E extends DomainEventLike>(
    recorder: UseCaseEventRecorderTarget,
    event: E,
    payload: InferUseCaseEventPayload<E>,
): Promise<void>
Validate and record a declared event into a transaction-scoped recorder.
Type Parameters
- E extends DomainEventLike
Parameters
- recorder: UseCaseEventRecorderTarget
- event: E
- payload: InferUseCaseEventPayload<E>
Returns Promise<void>
- Defined in packages/core/src/application/index.ts:216