Class SimpleEventBus<Events>

Simple event bus class that allows adding event listeners and emitting events. Events can be emitted by calling dispatchEvent.

Type Parameters

Events extends Record<EventType, unknown> = never
A type representing the events that the instance can emit and listen to.

Hierarchy (View Summary)

EventEmitterBase<Events>
- SimpleEventBus

Implements

EventBus<Events>

Index

Constructors

Properties

Methods

addEventListener dispatchEvent

Constructors

constructor

new SimpleEventBus<Events extends Record<EventType, unknown> = never>(): SimpleEventBus<
Events,
>
Type Parameters
- Events extends Record<EventType, unknown> = never
  A type representing the events that the instance can emit and listen to.
Returns SimpleEventBus<Events>
Inherited from EventEmitterBase.constructor

Properties

`Protected` `Readonly`emitter

emitter: Emitter<Events> = ...

An event emitter for handling custom events.

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.
Implementation of EventBus.addEventListener
Inherited from EventEmitterBase.addEventListener
- Defined in packages/sdk/core/src/lib/Event/EventEmitter.ts:76

dispatchEvent

dispatchEvent<K extends string | number | symbol>(
...event: DispatchArgsOf<Events, K>,
): void
Dispatches the given event with given payload on the plugin.
Type Parameters
- K extends string | number | symbol
Parameters
- ...event: DispatchArgsOf<Events, K>
  The event to listen to.
Returns void
Implementation of EventBus.dispatchEvent
- Defined in packages/sdk/core/src/lib/Event/EventEmitter.ts:93