# vue-event-x

> vue-event mananger

Latest version **1.0.8** (published 2018-12-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install vue-event-x
pnpm add vue-event-x
yarn add vue-event-x
bun add vue-event-x
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2018-12-05 |
| First published | 2018-11-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | sun.xianfeng |
| Maintainers | sun.xianfeng |

## Links

- npm: https://www.npmjs.com/package/vue-event-x
- Repository: https://github.com/Wukung1010/vue-event
- Homepage: https://github.com/Wukung1010/vue-event#readme
- Issues: https://github.com/Wukung1010/vue-event/issues
- npm.io page: https://npm.io/package/vue-event-x

## Recent versions

- 1.0.8 (latest) — 2018-12-05
- 1.0.7 — 2018-12-05
- 1.0.6 — 2018-12-05
- 1.0.5 — 2018-11-09
- 1.0.4 — 2018-11-09
- 1.0.3 — 2018-11-09
- 1.0.2 — 2018-11-09
- 1.0.1 — 2018-11-08
- 1.0.0 — 2018-11-05

## README

# 基于 Vue 的事件管理

## 使用方法

```javascript
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。

```javascript
this.$EventX = {
    createNewBus,
    destroy,
    error,
    isDestroy,
    state
};
```

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

## 事件总线的 api

```javascript
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

异步事件

错误实现

---
_Source: https://npm.io/package/vue-event-x · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._