@bluelibs/runner - v5.5.0
    Preparing search index...

    Interface IEvent<TPayload>

    The definioten of the event. This is different from the event emission.

    interface IEvent<TPayload = any> {
        "[symbolEvent]": true;
        "[symbolFilePath]": string;
        id: string;
        meta?: IEventMeta;
        optional: () => IOptionalDependency<IEvent<TPayload>>;
        parallel?: boolean;
        payloadSchema?: IValidationSchema<TPayload>;
        tags: TagType[];
    }

    Type Parameters

    • TPayload = any

    Hierarchy (View Summary)

    Index

    Properties

    "[symbolEvent]": true

    We use this event to discriminate between resources with just 'id' and 'events' as they collide. This is a workaround, should be redone using classes and instanceof.

    "[symbolFilePath]": string
    id: string
    meta?: IEventMeta

    Return an optional dependency wrapper for this event.

    parallel?: boolean

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

    payloadSchema?: IValidationSchema<TPayload>

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

    tags: TagType[]