Class EventEmitter<EventMap>

事件处理模块

Type Parameters

EventMap extends Record<string, any>

Index

Constructors

Methods

add emit off on once remove removeAll

Constructors

constructor

new EventEmitter<EventMap extends Record<string, any>>(): EventEmitter<EventMap>
Type Parameters
- EventMap extends Record<string, any>
Returns EventEmitter<EventMap>

Methods

add

add<K extends string | number | symbol>(
type: K,
listener: (event: EventMap[K]) => void,
): void
与 on 是同一个方法，只是方法名不同。
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  监听的事件类型，是个字符串。
- listener: (event: EventMap[K]) => void
  监听到事件类型后的处理函数。
Returns void
- Defined in client/types/ClientAPI.d.ts:77

emit

emit<K extends string | number | symbol>(type: K, event: EventMap[K]): void
触发指定的事件
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- event: EventMap[K]
Returns void
- Defined in client/types/ClientAPI.d.ts:93

off

off<K extends string | number | symbol>(
type: K,
listener: (event: EventMap[K]) => void,
): void
与 remove 是同一个方法，只是方法名不同。
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  要移除的事件类型。
- listener: (event: EventMap[K]) => void
  要移除的事件处理函数。
Returns void
- Defined in client/types/ClientAPI.d.ts:86

on

on<K extends string | number | symbol>(
type: K,
listener: (event: EventMap[K]) => void,
): void
监听指定的事件。
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  监听的事件类型，是个字符串。
- listener: (event: EventMap[K]) => void
  监听到事件类型后的处理函数。
Returns void
- Defined in client/types/ClientAPI.d.ts:41

once

once<K extends string | number | symbol>(
type: K,
listener: (event: EventMap[K]) => void,
): void
与 on 的区别是仅触发一次。
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  监听的事件类型，是个字符串。
- listener: (event: EventMap[K]) => void
  监听到事件类型后的处理函数。
Returns void
- Defined in client/types/ClientAPI.d.ts:50

remove

remove<K extends string | number | symbol>(
type: K,
listener: (event: EventMap[K]) => void,
): void
移除找到的第一个 listener。
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  要移除的事件类型。
- listener: (event: EventMap[K]) => void
  要移除的事件处理函数。
Returns void
- Defined in client/types/ClientAPI.d.ts:59

removeAll

removeAll<K extends string | number | symbol>(
type?: K,
listener?: (event: EventMap[K]) => void,
): void
移除找到的所有 listener，不传则移除事件下所有。
Type Parameters
- K extends string | number | symbol
Parameters
- Optionaltype: K
  要移除的事件类型。
- Optionallistener: (event: EventMap[K]) => void
  可选，要移除的事件处理函数。
Returns void
- Defined in client/types/ClientAPI.d.ts:68