Class Evented

事件基础函数（类，默认构造函数）

维护两个事件监听器队列（同步、异步）
提供事件监听、移除、触发等方法
提供一次性事件监听
提供获取指定事件类型的监听器
提供判断是否存在指定事件类型的监听器

参考 Leaflet 的事件机制设计

Hierarchy

Evented

Index

Constructors

Properties

_asyncEvents _events

Methods

emit emitAsync hasListeners listeners off on once removeAllListeners isAsyncListener

Constructors

constructor

new Evented(): Evented
Returns Evented

Properties

`Private` _asyncEvents

_asyncEvents: {
[event: string]: AsyncListener[];
} = {}

Type declaration

[event: string]: AsyncListener[]

`Private` _events

_events: {
[key: string]: Listener[];
} = {}

Type declaration

[key: string]: Listener[]

Methods

emit

emit(type, data?): Evented
只会触发非异步事件
Parameters
- type: string
- Optional data: any
Returns Evented
- Defined in src/core/events.ts:126

emitAsync

emitAsync(type, mode, data?): Promise<void>
异步触发事件
- parallel: 并行执行（同时执行所有处理函数）
- series: 串行执行（按照添加顺序执行）
- ignore: 忽略(在后台异步执行，但无法得知何时执行完毕)
Parameters
- type: string
  
  事件名称
- mode: "parallel" | "series" | "ignore"
  
  事件处理函数的执行模式('parallel' | 'series' | 'ignore')
- Optional data: any
Returns Promise<void>
返回一个 Promise 对象
- Defined in src/core/events.ts:151

hasListeners

hasListeners(type): boolean
判断是否存在指定事件类型的监听器
Parameters
- type: string
  
  事件名称
Returns boolean
返回一个布尔值
- Defined in src/core/events.ts:182

listeners

listeners(type): (Listener | AsyncListener)[]
获取指定事件类型的监听器
Parameters
- type: string
  
  事件名称
Returns (Listener | AsyncListener)[]
返回一个监听器数组
- Defined in src/core/events.ts:173

off

off(type, fn?, context?): Evented
移除事件监听
Parameters
- type: string
- Optional fn: Function
- Optional context: any
Returns Evented
- Defined in src/core/events.ts:65

on

on(type, fn, context?): Evented
添加事件监听（同步、异步）
Parameters
- type: string
  
  事件名称（类型）
- fn: Function
  
  事件处理函数（监听器）
- Optional context: any
  
  事件处理函数的上下文
Returns Evented
返回 EventEmitter 实例
- Defined in src/core/events.ts:41

once

once(type, fn, context?): Evented
添加一次性事件监听
Parameters
- type: string
- fn: Function
- Optional context: any
Returns Evented
- Defined in src/core/events.ts:112

removeAllListeners

removeAllListeners(): Evented
移除所有事件监听

Returns Evented
返回 EventEmitter 实例
- Defined in src/core/events.ts:190

`Static` isAsyncListener

isAsyncListener(listener): listener is AsyncListener
判断是否为异步监听器
Parameters
- listener: Listener | AsyncListener
  
  监听器
Returns listener is AsyncListener
返回一个布尔值
- Defined in src/core/events.ts:201

Generated using TypeDoc