Class EventEmitter

Constructors

constructor

new EventEmitter(): EventEmitter

Returns EventEmitter

Methods

clear

clear(event?: string): void
清除指定事件的所有处理函数不传参数时清除所有事件的所有处理函数
Parameters
- Optionalevent: string
  要清除的事件名称；省略则清空所有事件
Returns void
- Defined in event.ts:77

emit

emit<T = unknown>(event: string, data?: T): void
触发事件，调用所有已注册的处理函数并传入数据
Type Parameters
- T = unknown
Parameters
- event: string
  事件名称
- Optionaldata: T
  传递给处理函数的数据，可选
Returns void
- Defined in event.ts:47

off

off<T = unknown>(event: string, handler: EventHandler<T>): void
取消订阅指定事件的某个处理函数
Type Parameters
- T = unknown
Parameters
- event: string
  事件名称
- handler: EventHandler<T>
  要移除的处理函数引用
Returns void
- Defined in event.ts:38

on

on<T = unknown>(event: string, handler: EventHandler<T>): () => void
订阅一个事件，返回取消订阅的函数
Type Parameters
- T = unknown
Parameters
- event: string
  事件名称
- handler: EventHandler<T>
  事件处理函数
Returns () => void
取消订阅函数，调用后停止接收该事件
Example
```
const emitter = new EventEmitter()
const off = emitter.on('login', (user) => console.log(user))
off() // 取消订阅
```
- Defined in event.ts:22

once

once<T = unknown>(event: string, handler: EventHandler<T>): () => void
订阅事件，仅触发一次后自动取消订阅，返回取消订阅的函数可在事件触发前主动调用返回的函数来取消订阅
Type Parameters
- T = unknown
Parameters
- event: string
  事件名称
- handler: EventHandler<T>
  事件处理函数，仅执行一次
Returns () => void
取消订阅函数，调用后即使事件再次触发也不会执行 handler
Example
```
const off = emitter.once('ready', (data) => init(data))
off() // 如需提前取消，手动调用
```
- Defined in event.ts:63