/
eventBus.ts
58 lines (51 loc) · 1.43 KB
/
eventBus.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
import { EventBus, type EventBusListener } from '@ima/core';
import { useCallback, useEffect, useMemo } from 'react';
import { useComponentUtils } from './componentUtils';
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 function useEventBus(
eventTarget?: EventTarget | null,
eventName?: string,
listener?: EventBusListener
): useEventBusType {
const { $EventBus } = useComponentUtils();
const memoListener = useCallback(
(...args: Parameters<EventBusListener>) => {
listener?.(...args);
},
[listener]
);
useEffect(() => {
if (!eventTarget || !eventName || !memoListener) {
return;
}
$EventBus.listen(eventTarget, eventName, memoListener);
return () => {
$EventBus.unlisten(eventTarget, eventName, memoListener);
};
}, [$EventBus, eventName, eventTarget, memoListener]);
return useMemo<useEventBusType>(
() => ({
fire: (...params) => $EventBus.fire(...params),
}),
[$EventBus]
);
}