/** * @module EventBus */ import { type IReadableContext } from "../../execution-context/contracts/_module.js"; import { type InvocableFn } from "../../utilities/_module.js"; /** * IMPORT_PATH: `"@daiso-tech/core/event-bus/contracts"` * @group Contracts */ export type BaseEvent = Record; /** * IMPORT_PATH: `"@daiso-tech/core/event-bus/contracts"` * @group Contracts */ export type EventListenerFn = InvocableFn<[event: TEvent]>; /** * IMPORT_PATH: `"@daiso-tech/core/event-bus/contracts"` * @group Contracts */ export type IEventBusDispatcherAdapter = { /** * The `dispatch` method is used for dispatching one or multiple `events`. */ dispatch(eventName: string, eventData: BaseEvent, context: IReadableContext): Promise; }; /** * IMPORT_PATH: `"@daiso-tech/core/event-bus/contracts"` * @group Contracts */ export type IEventBusListenableAdapter = { /** * The `addListener` method is used for adding {@link EventListenerFn | `EventListenerFn`} for certain `eventName`. */ addListener(eventName: string, listener: EventListenerFn, context: IReadableContext): Promise; /** * The `removeListener` method is used for removing {@link EventListenerFn | `EventListenerFn`} for certain `eventName`. */ removeListener(eventName: string, listener: EventListenerFn, context: IReadableContext): Promise; }; /** * 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"` * @group Contracts */ export type IEventBusAdapter = IEventBusDispatcherAdapter & IEventBusListenableAdapter;