@wedjs/event

介绍

使用 观察者模式 封装了事件的订阅发布

安装

通过 NPM 安装：

npm i @wedjs/event

或者 直接引用 CDN：

<script src="https://cdn.wangerdi.cn/wedjs/event.js"></script>

使用

_.on(event, callback)

监听当前实例上的自定义事件。事件可以由_.emit触发。回调函数会接收所有传入事件触发函数的额外参数。

参数

| 参数名 | 类型 | 默认值 | 是否必填 | 描述 | | --- | --- | --- | --- | --- | | event | String | | 必填 | 事件名称 | | callback | Function | | 必填 | 回调函数 |

示例

  _.on('test', function(msg) {
    console.log(msg)
  })
  _.emit('test', 'hi'); // "hi"

_.once(event, callback)

监听一个自定义事件，但是只触发一次。一旦触发之后，监听器就会被移除。

参数

| 参数名 | 类型 | 默认值 | 是否必填 | 描述 | | --- | --- | --- | --- | --- | | event | String | | 必填 | 事件名称 | | callback | Function | | 必填 | 回调函数 |

_.off(event, callback)

移除自定义事件监听器。

• 如果没有提供参数，则移除所有的事件监听器；
• 如果只提供了事件，则移除该事件所有的监听器；
• 如果同时提供了事件与回调，则只移除这个回调的监听器。

参数

| 参数名 | 类型 | 默认值 | 是否必填 | 描述 | | --- | --- | --- | --- | --- | | event | String | | 可选 | 事件名称 | | callback | Function | | 可选 | 回调函数 |

_.emit(event, […args])

触发当前实例上的事件。附加参数都会传给监听器回调。

参数

| 参数名 | 类型 | 默认值 | 是否必填 | 描述 | | --- | --- | --- | --- | --- | | event | String | | 必选 | 事件名称 | | […args] | any | | 可选 | 附加参数 |