Type Alias IEventBusAdapter

IEventBusAdapter: {
    addListener(
        eventName: string,
        listener: EventListenerFn<BaseEvent>,
    ): PromiseLike<void>;
    dispatch(eventName: string, eventData: BaseEvent): PromiseLike<void>;
    removeListener(
        eventName: string,
        listener: EventListenerFn<BaseEvent>,
    ): PromiseLike<void>;
}

The IEventBusAdapter contract defines a way for dispatching and listening to events independent of underlying technology. This contract is not meant to be used directly, instead you should use IEventBus

IMPORT_PATH: "@daiso-tech/core/event-bus/contracts"

Type declaration

addListener:function
- addListener(
  eventName: string,
  listener: EventListenerFn<BaseEvent>,
  ): PromiseLike<void>
- The addListener method is used for adding listener for certain eventName.
  Parameters
  - eventName: string
  - listener: EventListenerFn<BaseEvent>
  Returns PromiseLike<void>
  - Defined in src/event-bus/contracts/event-bus-adapter.contract.ts:32
dispatch:function
- dispatch(eventName: string, eventData: BaseEvent): PromiseLike<void>
- The dispatch method is used for dispatching one or multiple events.
  Parameters
  - eventName: string
  - eventData: BaseEvent
  Returns PromiseLike<void>
  - Defined in src/event-bus/contracts/event-bus-adapter.contract.ts:48
removeListener:function
- removeListener(
  eventName: string,
  listener: EventListenerFn<BaseEvent>,
  ): PromiseLike<void>
- The removeListener method is used for removing listener for certain eventName.
  Parameters
  - eventName: string
  - listener: EventListenerFn<BaseEvent>
  Returns PromiseLike<void>
  - Defined in src/event-bus/contracts/event-bus-adapter.contract.ts:40

Type Alias IEventBusAdapter

Type declaration

addListener:function

Parameters

Returns PromiseLike<void>

dispatch:function

Parameters

Returns PromiseLike<void>

removeListener:function

Parameters

Returns PromiseLike<void>

Settings