vue-event-x

1.0.8 • Public • Published

基于 Vue 的事件管理

使用方法

import Event, { EventMixin } from "vue-event-x";

Vue.use(Event);

new Vue({ mixins: [EventMixin(eventName | { options })] });

导入 Event 之后使用 use 进行安装。

当你的组件存在习销毁和重建的时候,你需要混入 EventMixin(建议无脑混入)。

EventMixin 混入接受一个字符串,或者是 options 配置对象,会自动创建事件总线。

options

配置参数

属性 类型 描述
name String 事件总线名称
replace Boolean 如果名称重复,是否进行覆盖,覆盖会删掉之前重名的事件总线,然后创建新的总线

$EventX,全局对象是 event-x 的通用 api。

this.$EventX = {
    createNewBus,
    destroy,
    error,
    isDestroy,
    state
};
方法 参数 描述
createNewBus {name: 'eventName'} 创建新的消息总线,需要传入消息总线的名称。
destroy {name: 'eventName'} 销毁消息总线,需要传入消息总线的名称。
error fn 全局错误处理。
isDestroyed name 查询消息总线的是否被销毁。
state name|null 查询消息总线的状态。

事件总线的 api

this.$demoEvent = {
    on,
    off,
    emit,
    error,
    offError,
    destroy,
    state
};
方法 参数 描述
on type,fn,option|[{type,fn,option}]|{type: fn} 监听事件
off type, fn, isAll=false 卸载监听事件处理器,isAll=true 的时候会同时写在所有的错误处理
emit type,...args 事件触发
error fn|type,fn 错误处理,只传 fn 则全局错误处理,传入 type 可以对单个事件进行错误处理。fn 的参数为:error, type, ...data
offError fn|type,fn 卸载错误处理器,传入 type 卸载指定类型的错误处理器,未传入 type 咋卸载对应的全局错误处理器
destroy 销毁当前时间总线
state 当前总线状态

Future

异步事件

错误实现

Readme

Keywords

none

Package Sidebar

Install

npm i vue-event-x

Weekly Downloads

1

Version

1.0.8

License

ISC

Unpacked Size

18.6 kB

Total Files

14

Last publish

Collaborators

  • sun.xianfeng