@miyue-mma/shared / EventEmitter

类: EventEmitter

事件发布订阅

构造函数

new EventEmitter()

new EventEmitter(): EventEmitter

返回

EventEmitter

方法

addListener()

addListener(
   type, 
   fn, 
   context?, 
   once?): EventEmitter

注册事件订阅函数

参数

type

事件类型

string | string[]

fn

EventEmitterListener

回调函数

context?

unknown

上下文

once?

boolean

是否只执行一次

返回

EventEmitter

---

emit()

emit(type, ...rest): false | EventEmitter

触发事件

参数

type

string

事件类型

rest

...any[]

回调函数参数

返回

false | EventEmitter

---

eventNames()

eventNames(): (string | symbol)[]

获取所有已经订阅的事件

返回

(string | symbol)[]

---

hasListener()

hasListener(type, fn): boolean

检查是否存在事件订阅函数

参数

type

string

事件类型

fn

EventEmitterListener

回调函数参数

返回

boolean

---

listeners()

listeners(type): 
  | undefined
  | EventEmitterListener[]

获取某个事件的所有订阅函数

参数

type

string

事件类型

返回

| undefined | EventEmitterListener[]

---

listenersCount()

listenersCount(type): number

获取某个事件的订阅函数数量

参数

type

string

事件类型

返回

number

---

on()

on(
   type, 
   fn, 
   context?): EventEmitter

注册事件订阅函数

参数

type

string

事件类型

fn

any

回调函数

context?

any

上下文

返回

EventEmitter

---

once()

once(
   type, 
   fn, 
   context?): EventEmitter

注册事件订阅函数，只执行一次

参数

type

string

事件类型

fn

any

回调函数

context?

any

上下文

返回

EventEmitter

---

removeAllListeners()

removeAllListeners(type?): any

移除事件订阅函数，指定类型时移除该类型的所有订阅函数，不指定类型时移除所有

参数

type?

string

事件类型

返回

any

---

removeListener()

removeListener(type, fn?): EventEmitter

移除事件订阅函数，指定 fn 时只移除指定的 fn，不指定 fn 时移除所有

参数

type

事件类型

string | string[]

fn?

EventEmitterListener

回调函数参数

返回

EventEmitter