EventDispatcher<Events>
Defined in: packages/utils/src/tools/event.ts:27
类型安全的同步事件调度器。
派发语义与 DOM EventTarget 对齐:
dispatchEvent对监听器集合取快照后再遍历。派发过程中新增的监听器 不会收到本次事件,要等下一次派发;派发过程中移除的监听器仍会被本次调用到。- 监听器抛出的异常不被吞掉,直接向调用方冒泡,后续监听器不再执行。
- 只有
addEventListener会为事件名建立集合;集合被删空后立即回收该事件名, 避免事件名无界时 Map 持续增长。
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
Events extends object | EventMap |
Implements
IEventDispatcher<Events>
Constructors
Constructor
new EventDispatcher<Events>(): EventDispatcher<Events>;
Returns
EventDispatcher<Events>
Methods
addEventListener()
addEventListener<T>(type, listener): void;
Defined in: packages/utils/src/tools/event.ts:36
注册监听器。同一 listener 重复注册只保留一份(集合语义)。
Type Parameters
| Type Parameter |
|---|
T extends string | number | symbol |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
listener | EventListener<Events[T]> | 监听器 |
Returns
void
Implementation of
IEventDispatcher.addEventListener
dispatchEvent()
dispatchEvent<T>(type, data): void;
Defined in: packages/utils/src/tools/event.ts:81
同步派发事件。
遍历的是快照而非实时集合:监听器在处理过程中 addEventListener 不会自喂
本轮迭代(否则单次同步派发可被第三方监听器无限延长,UTL-011)。
Type Parameters
| Type Parameter |
|---|
T extends string | number | symbol |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
data | Events[T] | 事件数据 |
Returns
void
Throws
监听器抛出的任意异常,原样向上冒泡;其后的监听器不再执行
Implementation of
IEventDispatcher.dispatchEvent
hasEventListener()
hasEventListener<T>(type, listener): boolean;
Defined in: packages/utils/src/tools/event.ts:52
查询监听器是否已注册。不会为未知事件名建立集合。
Type Parameters
| Type Parameter |
|---|
T extends string | number | symbol |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
listener | EventListener<Events[T]> | 监听器 |
Returns
boolean
是否已注册
Implementation of
IEventDispatcher.hasEventListener
removeAllEventListeners()
removeAllEventListeners(): void;
Defined in: packages/utils/src/tools/event.ts:90
清空所有事件名下的全部监听器。
Returns
void
Implementation of
IEventDispatcher.removeAllEventListeners
removeEventListener()
removeEventListener<T>(type, listener): void;
Defined in: packages/utils/src/tools/event.ts:64
移除监听器。未知事件名或未注册的监听器都是无操作,且不会建立空集合。
若在 dispatchEvent 过程中移除,被移除者仍会收到本次事件(快照语义)。
Type Parameters
| Type Parameter |
|---|
T extends string | number | symbol |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
listener | EventListener<Events[T]> | 监听器 |
Returns
void