1.0.0-Alpha.7 • Published 4 years ago

@wedjs/event v1.0.0-Alpha.7

Weekly downloads
-
License
-
Repository
-
Last release
4 years ago

@wedjs/event


介绍

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


安装

通过 NPM 安装:

npm i @wedjs/event

或者 直接引用 CDN

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

使用

_.on(event, callback)

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

参数
参数名类型默认值是否必填描述
eventString必填事件名称
callbackFunction必填回调函数
示例
  _.on('test', function(msg) {
    console.log(msg)
  })
  _.emit('test', 'hi'); // "hi"

_.once(event, callback)

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

参数
参数名类型默认值是否必填描述
eventString必填事件名称
callbackFunction必填回调函数

_.off(event, callback)

移除自定义事件监听器。
  • 如果没有提供参数,则移除所有的事件监听器;
  • 如果只提供了事件,则移除该事件所有的监听器;
  • 如果同时提供了事件与回调,则只移除这个回调的监听器。
参数
参数名类型默认值是否必填描述
eventString可选事件名称
callbackFunction可选回调函数

_.emit(event, …args)

触发当前实例上的事件。附加参数都会传给监听器回调。
参数
参数名类型默认值是否必填描述
eventString必选事件名称
…argsany可选附加参数