chimee-helper-events

events handler of chimee

get started

npm install chimee-helper-events --save

doc

event

src/index.js:16-16

自定义事件基础类

Meta

• author: huzunjie

getEvtTypeCache

src/index.js:25-48

得到某对象的某事件类型对应的监听队列数组

Parameters

• target Object 发生事件的对象
• type String 事件类型(这里的时间类型不只是名称，还是缓存标识，可以通过添加后缀来区分)

Returns Array

emitEventCache

src/index.js:57-67

触发事件监听方法

Parameters

• target Object 发生事件的对象
• type String 事件类型
• eventObj Object 触发事件时要传回的event对象

Returns undefined

addEventCache

src/index.js:78-94

添加事件监听到缓存

Parameters

• target Object 发生事件的对象
• type String 事件类型
• handler Function 监听函数
• isOnce Boolean 是否单次执行 (optional, default false)
• handlerWrap Function

Returns undefined

removeEventCache

src/index.js:103-126

移除事件监听

Parameters

• target Object 发生事件的对象
• type String 事件类型
• handler Function 监听函数
• isOnce (optional, default false)

Returns undefined

CustEvent

src/index.js:139-208

Event 自定义事件类 1. 可以使用不传参得到的实例作为eventBus使用 2. 可以通过指定target，用多个实例操作同一target对象的事件管理 3. 当设定target时，可以通过设置assign为true，来给target实现"on\once\off\emit"方法

Parameters

• target Object 发生事件的对象（空则默认为event实例）
• assign Boolean 是否将"on\once\off\emit"方法实现到target对象上

Returns event

on

src/index.js:172-175

添加事件监听

Parameters

• type String 事件类型
• handler Function 监听函数
• isOnce Boolean 单次监听类型 (optional, default false)

Returns event

once

src/index.js:183-185

添加事件监听,并且只执行一次

Parameters

• type String 事件类型
• handler Function 监听函数

Returns event

off

src/index.js:194-197

移除事件监听

Parameters

• type String 事件类型
• handler Function 监听函数(不指定handler则清除type对应的所有事件监听)
• isOnce Boolean 单次监听类型 (optional, default false)

Returns event

emit

src/index.js:204-207

触发事件监听函数

Parameters

• type String 事件类型
• data

Returns event