Interface EventBus<Events>

Convenience interface for objects that are both an EventEmitter and an EventDispatcher.

interface EventBus<Events extends Record<EventType, unknown>> {
    addEventListener<K extends string | number | symbol>(
        event: K,
        listener: (eventData: Events[K]) => void,
    ): EventHandle;
    dispatchEvent<K extends string | number | symbol>(
        ...args: DispatchArgsOf<Events, K>,
    ): void;
}

Type Parameters

Events extends Record<EventType, unknown>

Hierarchy (View Summary)

EventEmitter<Events>
EventDispatcher<Events>
- EventBus

Index

Methods

addEventListener dispatchEvent

Methods

addEventListener

addEventListener<K extends string | number | symbol>(
event: K,
listener: (eventData: Events[K]) => void,
): EventHandle
Adds an event listener for a specific event.
Type Parameters
- K extends string | number | symbol
  The type of the event key.
Parameters
- event: K
  The event to listen to.
- listener: (eventData: Events[K]) => void
  The callback function to be invoked when the event is emitted.
Returns EventHandle
An EventHandle with a remove method to unsubscribe the listener.
Inherited from EventEmitter.addEventListener
- Defined in packages/sdk/core/src/lib/Event/EventEmitter.ts:28

dispatchEvent

dispatchEvent<K extends string | number | symbol>(
...args: DispatchArgsOf<Events, K>,
): void
Dispatches the given event with given payload on the plugin.
Type Parameters
- K extends string | number | symbol
Parameters
- ...args: DispatchArgsOf<Events, K>
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in packages/sdk/core/src/lib/Event/EventEmitter.ts:50

Interface EventBus<Events>

Type Parameters

Hierarchy (View Summary)

Index

Methods

Methods

addEventListener

Type Parameters

Parameters

Returns EventHandle

dispatchEvent

Type Parameters

Parameters

Returns void

Settings

On This Page