Class EventEmitter<T>

事件发射器

Type Parameters

T = any

Hierarchy

EventEmitter

Index

Constructors

constructor

new EventEmitter<T>(target?): EventEmitter<T>
Type Parameters
- T = any
Parameters
- Optional target: any
Returns EventEmitter<T>
- Defined in packages/event/src/EventEmitter.ts:56

Properties

`Static` `Private` emitterListenerMap

emitterListenerMap: Map<EventEmitter<any>, ObjectListener> = ...

发射器与监听器映射。

`Static` `Private` emitterTargetMap

emitterTargetMap: Map<EventEmitter<any>, IEventTarget> = ...

发射器与目标映射。

`Static` `Private` targetEmitterMap

targetEmitterMap: Map<any, EventEmitter<any>> = ...

目标与发射器映射。

Methods

broadcast

broadcast<K>(type, data?): IEvent<T[K]>
将事件广播到下级对象中。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: T[K]
  
  事件携带的自定义数据。
Returns IEvent<T[K]>
返回广播后的事件。
- Defined in packages/event/src/EventEmitter.ts:176

bubbles

bubbles<K>(type, data?): IEvent<T[K]>
将事件冒泡到上级对象中。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: T[K]
  
  事件携带的自定义数据。
Returns IEvent<T[K]>
返回冒泡后的事件。
- Defined in packages/event/src/EventEmitter.ts:189

dispose

dispose(): void
销毁

Returns void
- Defined in packages/event/src/EventEmitter.ts:535

emit

emit<K>(type, data?, bubbles?, broadcast?, share?): IEvent<T[K]>
发射事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: T[K]
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<T[K]>
返回发射后的事件。
- Defined in packages/event/src/EventEmitter.ts:145

emitEvent

emitEvent<K>(event): IEvent<T[K]>
发射事件。

当事件重复流向一个对象时将不会被处理。
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件对象
Returns IEvent<T[K]>
返回事件是否被处理
- Defined in packages/event/src/EventEmitter.ts:110

eventNames

eventNames<K>(): K[]
返回监听的事件类型列表。
Type Parameters
- K extends string
Returns K[]
- Defined in packages/event/src/EventEmitter.ts:70

`Protected` handelEventBroadcast

handelEventBroadcast<K>(event): void
向下级广播事件
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件
Returns void
- Defined in packages/event/src/EventEmitter.ts:506

`Protected` handelEventBubbles

handelEventBubbles<K>(event): void
向上级报告事件
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件
Returns void
- Defined in packages/event/src/EventEmitter.ts:475

`Protected` handelEventShare

handelEventShare<K>(event): void
向平级分享事件
Type Parameters
- K extends string
Parameters
- event: IEvent<T[K]>
  
  事件
Returns void
- Defined in packages/event/src/EventEmitter.ts:451

`Protected` handleEvent

handleEvent<K>(e): void
处理事件
Type Parameters
- K extends string
Parameters
- e: IEvent<T[K]>
  
  事件
Returns void
- Defined in packages/event/src/EventEmitter.ts:389

has

has<K>(type): boolean
检查 Event 对象是否为特定事件类型注册了任何侦听器.
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns boolean
如果指定类型的侦听器已注册，则值为 true；否则，值为 false。
- Defined in packages/event/src/EventEmitter.ts:200

listenerCount

listenerCount<K>(type): number
返回指定事件类型的监听数量。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns number
- Defined in packages/event/src/EventEmitter.ts:82

off

off<K>(type?, listener?, thisObject?): EventEmitter<T>
移除监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
- Optional listener: ((event) => void)
  
  要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。
  - - (event): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns EventEmitter<T>
- Defined in packages/event/src/EventEmitter.ts:253

offAll

offAll<K>(type?): EventEmitter<T>
移除所有监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
Returns EventEmitter<T>
- Defined in packages/event/src/EventEmitter.ts:303

offAny

offAny<K>(listener?, thisObject?): EventEmitter<T>
移除监听对象的任意事件。
Type Parameters
- K extends string
Parameters
- Optional listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns EventEmitter<T>
- Defined in packages/event/src/EventEmitter.ts:353

on

on<K>(type, listener, thisObject?, priority?, once?): EventEmitter<T>
为监听对象新增指定类型的事件监听。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns EventEmitter<T>
- Defined in packages/event/src/EventEmitter.ts:214

onAny

onAny<K>(listener, thisObject?, priority?, once?): EventEmitter<T>
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
Type Parameters
- K extends string
Parameters
- listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns EventEmitter<T>
- Defined in packages/event/src/EventEmitter.ts:318

once

once<K>(type, listener, thisObject?, priority?): EventEmitter<T>
监听一次事件后将会被移除
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event) => void)
  
  处理事件的侦听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<T[K]>
      
      Returns void
- Optional thisObject: any
  
  listener函数作用域
- priority: number = 0
  
  事件侦听器的优先级。数字越大，优先级越高。默认优先级为 0。
Returns EventEmitter<T>
- Defined in packages/event/src/EventEmitter.ts:95

`Static` getEventEmitter

getEventEmitter(target): EventEmitter<any>
获取事件发射器
Parameters
- target: any
Returns EventEmitter<any>
- Defined in packages/event/src/EventEmitter.ts:29

`Static` getOrCreateEventEmitter

getOrCreateEventEmitter(target): EventEmitter<any>
获取事件发射器，当没有找到对应发射器时，返回新建的事件发射器。
Parameters
- target: any
Returns EventEmitter<any>
- Defined in packages/event/src/EventEmitter.ts:44

Class EventEmitter<T>

Type Parameters

T = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T = any

Parameters

Optional target: any

Returns EventEmitter<T>

Properties

Static Private emitterListenerMap

Static Private emitterTargetMap

Static Private targetEmitterMap

Methods

broadcast

Type Parameters

K extends string

Parameters

type: K

Optional data: T[K]

Returns IEvent<T[K]>

bubbles

Type Parameters

K extends string

Parameters

type: K

Optional data: T[K]

Returns IEvent<T[K]>

dispose

Returns void

emit

Type Parameters

K extends string

Parameters

type: K

Optional data: T[K]

bubbles: boolean = false

broadcast: boolean = false

share: boolean = true

Returns IEvent<T[K]>

emitEvent

Type Parameters

K extends string

Parameters

event: IEvent<T[K]>

Returns IEvent<T[K]>

eventNames

Type Parameters

K extends string

Returns K[]

Protected handelEventBroadcast

Type Parameters

K extends string

Parameters

event: IEvent<T[K]>

Returns void

Protected handelEventBubbles

Type Parameters

K extends string

Parameters

event: IEvent<T[K]>

Returns void

Protected handelEventShare

Type Parameters

K extends string

Parameters

event: IEvent<T[K]>

Returns void

Protected handleEvent

Type Parameters

K extends string

Parameters

e: IEvent<T[K]>

Returns void

`Optional` target: any

`Static` `Private` emitterListenerMap

`Static` `Private` emitterTargetMap

`Static` `Private` targetEmitterMap

`Optional` data: T[K]

`Optional` data: T[K]

`Optional` data: T[K]

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent

`Optional` type: K

`Optional` listener: ((event) => void)

`Optional` thisObject: any

`Optional` type: K

`Optional` listener: ((event) => void)

`Optional` thisObject: any

`Optional` thisObject: any

`Optional` thisObject: any