Class AnyEmitter<O, T>

任意事件发射器。

可以为任何对象甚至基础类型发射事件。

可针对（除undefined、null、Symbol外）的任意对象（0, 1, true, false, "1", {}）发射事件

Type Parameters

O = any
T = any

Hierarchy

AnyEmitter

Index

Constructors

constructor

Methods

emit emitEvent eventNames has listenerCount off offAll offAny on onAny once

Constructors

constructor

new AnyEmitter<O, T>(): AnyEmitter<O, T>
Type Parameters
- O = any
- T = any
Returns AnyEmitter<O, T>

Methods

emit

emit<K>(obj: O, type: K, data?: T[K], bubbles?: boolean, broadcast?: boolean, share?: boolean): IEvent<T[K]>
将事件调度到事件流中. 事件目标是对其调用 emitEvent() 方法的 IEvent 对象。
Type Parameters
- K extends string
Parameters
- obj: O
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: T[K]
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<T[K]>
- Defined in src/event/AnyEmitter.ts:76

emitEvent

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

当事件重复流向一个对象时将不会被处理。

Returns
返回事件是否被该对象处理。
Type Parameters
- K extends string
Parameters
- obj: O
- event: IEvent<T[K]>
  
  事件对象。
Returns IEvent<T[K]>
- Defined in src/event/AnyEmitter.ts:59

eventNames

eventNames(obj: O): string[]
Return an array listing the events for which the emitter has registered listeners.
Parameters
- obj: O
Returns string[]
- Defined in src/event/AnyEmitter.ts:17

has

has<K>(obj: O, type: K): boolean
检查被监听对象是否为特定事件类型注册了任何监听器.

Returns
如果指定类型的监听器已注册，则值为 true；否则，值为 false。
Type Parameters
- K extends string
Parameters
- obj: O
  
  被监听对象。
- type: K
  
  事件的类型。
Returns boolean
- Defined in src/event/AnyEmitter.ts:91

listenerCount

listenerCount<K>(obj: O, type: K): number
Return the number of listeners listening to a given event.
Type Parameters
- K extends string
Parameters
- obj: O
- type: K
Returns number
- Defined in src/event/AnyEmitter.ts:28

off

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

offAll

offAll<K>(obj: O, type?: K): AnyEmitter<O, T>
Remove all listeners, or those of the specified event.
Type Parameters
- K extends string
Parameters
- obj: O
- Optional type: K
Returns AnyEmitter<O, T>
- Defined in src/event/AnyEmitter.ts:136

offAny

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

on

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

onAny

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

once

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

Class AnyEmitter<O, T>

Type Parameters

O = any

T = any

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

O = any

T = any

Returns AnyEmitter<O, T>

Methods

emit

Type Parameters

K extends string

Parameters

obj: O

type: K

Optional data: T[K]

bubbles: boolean = false

broadcast: boolean = false

share: boolean = true

Returns IEvent<T[K]>

emitEvent

Returns

Type Parameters

K extends string

Parameters

obj: O

event: IEvent<T[K]>

Returns IEvent<T[K]>

eventNames

Parameters

obj: O

Returns string[]

has

Returns

Type Parameters

K extends string

Parameters

obj: O

type: K

Returns boolean

listenerCount

Type Parameters

K extends string

Parameters

obj: O

type: K

Returns number

off

Type Parameters

K extends string

Parameters

obj: O

Optional type: K

Optional listener: ((event: IEvent<T[K]>) => any)

Parameters

event: IEvent<T[K]>

Returns any

Optional thisObject: any

Returns AnyEmitter<O, T>

offAll

Type Parameters

K extends string

Parameters

obj: O

Optional type: K

Returns AnyEmitter<O, T>

offAny

Type Parameters

K extends string

Parameters

obj: O

Optional listener: ((event: IEvent<T[K]>) => void)

Parameters

event: IEvent<T[K]>

`Optional` data: T[K]

`Optional` type: K

`Optional` listener: ((event: IEvent<T[K]>) => any)

`Optional` thisObject: any

`Optional` type: K

`Optional` listener: ((event: IEvent<T[K]>) => void)

`Optional` thisObject: any

`Optional` thisObject: any

`Optional` thisObject: any