Class EventBus<T>

Type Parameters

T extends Record<string, unknown>

Hierarchy

EventBus

Index

Constructors

Properties

Methods

Constructors

constructor

new EventBus<T>(): EventBus<T>
Type Parameters
- T extends Record<string, unknown>
Returns EventBus<T>
- Defined in packages/toolkit/src/globals/event-bus/index.ts:14

Properties

`Private` #emitter

#emitter: EventEmitter<DefaultBusEventMap & T> = ...

Methods

emit

emit(eventName: EventMapKey<DefaultBusEventMap & T>, payload?: (DefaultBusEventMap & T)[EventMapKey<DefaultBusEventMap & T>]): void
Parameters
- eventName: EventMapKey<DefaultBusEventMap & T>
- Optional payload: (DefaultBusEventMap & T)[EventMapKey<DefaultBusEventMap & T>]
Returns void
- Defined in packages/toolkit/src/globals/event-bus/index.ts:25

off

off(eventName: EventMapKey<DefaultBusEventMap & T>, handlerFn: EventHandler<(DefaultBusEventMap & T)[EventMapKey<DefaultBusEventMap & T>]>): void
Parameters
- eventName: EventMapKey<DefaultBusEventMap & T>
- handlerFn: EventHandler<(DefaultBusEventMap & T)[EventMapKey<DefaultBusEventMap & T>]>
Returns void
- Defined in packages/toolkit/src/globals/event-bus/index.ts:32

on

on(eventName: EventMapKey<DefaultBusEventMap & T>, handlerFn: ((payload: unknown) => void)): void
Parameters
- eventName: EventMapKey<DefaultBusEventMap & T>
- handlerFn: ((payload: unknown) => void)
  - - (payload: unknown): void
    - Parameters
      
      payload: unknown
      
      Returns void
Returns void
- Defined in packages/toolkit/src/globals/event-bus/index.ts:18

Generated using TypeDoc