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

    Interface IEventEmission<TPayload>

    Concrete event emission passed to hooks and wildcard listeners.

    interface IEventEmission<TPayload = any> {
        "[symbolDefinitionIdentity]"?: object;
        data: TPayload;
        id: string;
        meta: IEventMeta;
        path?: string;
        signal?: AbortSignal;
        source: RuntimeCallSource;
        tags: EventTagType[];
        timestamp: Date;
        transactional: boolean;
        isPropagationStopped(): boolean;
        stopPropagation(): void;
    }

    Type Parameters

    • TPayload = any
    Index

    Properties

    [symbolDefinitionIdentity]? data id meta path? signal? source tags timestamp transactional

    Methods

    isPropagationStopped stopPropagation

    Properties

    "[symbolDefinitionIdentity]"?: object
    data: TPayload

    The data that the event carries. It can be anything.

    id: string

    The ID of the event. This is the same as the event's ID. This is useful for global event listeners.

    meta: IEventMeta

    Metadata associated with the event definition.

    path?: string
    signal?: AbortSignal

    Cooperative cancellation signal for this emission when one exists.

    source: RuntimeCallSource

    The source of the event. This can be useful for debugging.

    tags: EventTagType[]

    The tags that the event carries.

    timestamp: Date

    The timestamp when the event was created.

    transactional: boolean

    Whether this emission runs in transactional listener mode.

    Methods

    • Returns true if propagation has been stopped.

      Returns boolean

    • Stops propagation to remaining event listeners.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods