# message-event

**Repository Path**: Luomenghao/message-event

## Basic Information

- **Project Name**: message-event
- **Description**: 消息事件，发布、订阅二次封装，api丰富 ，使用起来更加快捷；
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-16
- **Last Updated**: 2023-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript

## README

# 消息事件

### 一、功能介绍

    针对发布、订阅进行了二次封装，其使用起来更加方便；

### 二、如何使用

#### 1、安装依赖

```javascript
// npm
npm install message-event -S;
// yarn
yarn add message-event -S
```

#### 2、使用

```javascript
import { MessageEvent } from 'message-event';

const messageEvent = new MessageEvent(); // 创建一个实例

/******************** 基础使用 ********************/
// 例子：如监听用户退出登录
messageEvent.on('system::logout', (data) => {
	console.log('用户退出登录', data);
});
// 发布事件
messageEvent.emit('system::logout', 'admin');

/******************** 其他用法 ********************/
// 只监听一次
messageEvent.once('system::logout', (data) => {
	console.log('只会触发一次：', data);
});
// 移出监听, 如果不带回掉函数，则会移出当前时间所有的监听函数
messageEvent.un('system::logout');
// 获取当前事件是否被注册
messageEvent.has('system::logout'); // true
```

### 三、方法说明

| 方法 | 参数                                | 说明             |
| ---- | ----------------------------------- | ---------------- |
| on   | on(key: string, (data) => {})       | 注册事件         |
| emit | emit(key: string, data: any)        | 发布事件         |
| un   | un(key: string, handler?: Function) | 取消注册         |
| once | once(key: string, (data) => {})     | 注册使用一次     |
| has  | has(key: string)                    | 当前名称是否注册 |