@ima/react-page-renderer/dist/esm/client/hooks/eventBus.d.ts

IMA.js React page renderer.

import { EventBus, type EventBusListener } from '@ima/core';
export interface useEventBusType {
    fire: EventBus['fire'];
}
/**
 * Hook to register listeners for dispatcher events. Returns
 * decorated dispatcher fire function. Omitting hook params
 * doesn't register any events to the dispatcher but provides
 * access to the dispatcher's fire method.
 *
 * @example
 * const { fire } = useEventBus(
 * 	componentRef.current,
 * 	'event',
 *  () => {}
 * );
 *
 * @param event Event name.
 * @param callback Callback to register to dispatcher.
 * @returns Dispatcher `fire` method.
 */
export declare function useEventBus(eventTarget?: EventTarget | null, eventName?: string, listener?: EventBusListener): useEventBusType;
//# sourceMappingURL=eventBus.d.ts.map