Interface IEventEmission<TPayload>

This represents the object that is passed to event handlers

interface IEventEmission<TPayload = any> {
    data: TPayload;
    id: string;
    meta: IEventMeta;
    source: string;
    tags: TagType[];
    timestamp: Date;
    isPropagationStopped(): boolean;
    stopPropagation(): void;
}

Type Parameters

TPayload = any

Index

Properties

data id meta source tags timestamp

Methods

isPropagationStopped stopPropagation

Properties

data

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

id

id: string

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

meta

meta: IEventMeta

Metadata associated with the event definition.

source

source: string

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

tags

tags: TagType[]

The tags that the event carries.

timestamp

timestamp: Date

The timestamp when the event was created.

Methods

isPropagationStopped

isPropagationStopped(): boolean
Returns true if propagation has been stopped.

Returns boolean
- Defined in src/types/event.ts:133

stopPropagation

stopPropagation(): void
Stops propagation to remaining event listeners.

Returns void
- Defined in src/types/event.ts:129