@ks-web/use 0.0.9 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/createGlobalState/index.d.ts +2 -0
- package/dist/index.cjs.js +426 -80
- package/dist/index.d.ts +2 -0
- package/dist/index.esm.mjs +426 -80
- package/dist/useEventBus/index.d.ts +35 -0
- package/dist/useEventBus/internal.d.ts +2 -0
- package/package.json +1 -1
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
export type Fn = () => void;
|
|
2
|
+
export type EventBusListener<T = unknown, P = any> = (event: T, payload?: P) => void;
|
|
3
|
+
export type EventBusEvents<T, P = any> = Set<EventBusListener<T, P>>;
|
|
4
|
+
export interface EventBusKey<T> extends Symbol {
|
|
5
|
+
}
|
|
6
|
+
export type EventBusIdentifier<T = unknown> = EventBusKey<T> | string | number;
|
|
7
|
+
export interface UseEventBusReturn<T, P> {
|
|
8
|
+
/**
|
|
9
|
+
* 消息订阅
|
|
10
|
+
* @param listener
|
|
11
|
+
* @returns 停止函数,用于删除当前回调。
|
|
12
|
+
*/
|
|
13
|
+
on: (listener: EventBusListener<T, P>) => Fn;
|
|
14
|
+
/**
|
|
15
|
+
* 和on一样,但是只监听一次
|
|
16
|
+
* @param listener watch listener.
|
|
17
|
+
* @returns 停止函数,用于删除当前回调。
|
|
18
|
+
*/
|
|
19
|
+
once: (listener: EventBusListener<T, P>) => Fn;
|
|
20
|
+
/**
|
|
21
|
+
* 派发消息
|
|
22
|
+
* @param event data sent.
|
|
23
|
+
*/
|
|
24
|
+
emit: (event?: T, payload?: P) => void;
|
|
25
|
+
/**
|
|
26
|
+
* 移除事件监听
|
|
27
|
+
* @param listener watch listener.
|
|
28
|
+
*/
|
|
29
|
+
off: (listener: EventBusListener<T>) => void;
|
|
30
|
+
/**
|
|
31
|
+
* 重置所有事件订阅
|
|
32
|
+
*/
|
|
33
|
+
reset: () => void;
|
|
34
|
+
}
|
|
35
|
+
export declare function useEventBus<T = unknown, P = any>(key: EventBusIdentifier<T>): UseEventBusReturn<T, P>;
|