@bluelibs/runner - v6.3.1
    Preparing search index...

    Interface IEventDefinition<TPayload>

    Declarative event definition contract.

    interface IEventDefinition<TPayload = void> {
        id: string;
        meta?: IEventMeta;
        parallel?: boolean;
        payloadSchema?: ValidationSchemaInput<TPayload>;
        tags?: EventTagType[];
        transactional?: boolean;
    }

    Type Parameters

    • TPayload = void

    Hierarchy (View Summary)

    Index

    Properties

    id: string

    Stable event identifier within its owner subtree.

    meta?: IEventMeta

    Optional metadata used by docs and tooling.

    parallel?: boolean

    If true, listeners with the same priority run concurrently within a batch. Batches (grouped by order) still execute sequentially in priority order.

    Optional validation schema for runtime payload validation. When provided, event payload will be validated when emitted.

    tags?: EventTagType[]

    Tags attached to the event for routing or policy decisions.

    transactional?: boolean

    If true, listeners run in transactional mode and must return an undo closure.