@neosjs/emitter
简易的事件订阅 / 发布器(EventEmitter),除常规的单窗口事件通信外,还支持基于广播通道的多窗口同步消息——一个浏览器窗口里发布的事件,其它同名通道的窗口也能收到。提供完整的 TypeScript 类型。
安装
sh
pnpm add @neosjs/emittersh
npm i @neosjs/emittersh
yarn add @neosjs/emitter快速上手
基础使用
ts
import NeosEmitter from '@neosjs/emitter'
const emitter = new NeosEmitter()
// 订阅
emitter.on('test', (data) => {
console.log(data)
})
// 发布
emitter.emit('test', 'hello world')多窗口同步
创建实例时开启 broadcast,多个窗口使用相同的 channelName 即可互通消息:
ts
import NeosEmitter from '@neosjs/emitter'
const emitter = new NeosEmitter({
channelName: 'neosjs', // 通道名称(默认值:@neosjs-broadcast-emitterevent)
broadcast: true, // 是否开启广播(多窗口同步消息)
debug: true // 是否开启调试(默认值:false)
})
// 窗口 B 订阅、监听事件
emitter.on('test', (data) => {
console.log(data)
})
// 窗口 A 发布事件
emitter.emit('test', 'hello world')API
构造参数
new NeosEmitter(options: EmitterOptions)
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
options | 配置项 | EmitterOptions | {} |
options.channelName | 通道名称 | string | @neosjs-broadcast-emitterevent |
options.broadcast | 是否开启广播 | boolean | false |
options.debug | 是否开启调试 | boolean | false |
实例方法
on(event: string, listener: Function)
订阅事件。
| 参数 | 说明 | 类型 |
|---|---|---|
event | 事件名称 | string |
listener | 事件监听器 | Function |
once(event: string, listener: Function)
订阅一次事件,触发后自动取消。
| 参数 | 说明 | 类型 |
|---|---|---|
event | 事件名称 | string |
listener | 事件监听器 | Function |
emit(event: string, data: any)
发布事件。
| 参数 | 说明 | 类型 |
|---|---|---|
event | 事件名称 | string |
data | 事件数据 | any |
off(event: string, listener?: Function)
取消订阅事件。
| 参数 | 说明 | 类型 |
|---|---|---|
event | 事件名称 | string |
listener | 事件监听器(可选) | Function |
destroy()
销毁实例。