接口 YmxEventBus

事件总线（跨页面、跨 Webview、跨窗口）通信

interface YmxEventBus {
    emit(data: EmitData): Promise<void>;
    off(data: UnsubscribeEvent): Promise<void>;
    on(data: SubscribeEvent): Promise<void>;
    once(data: SubscribeEvent): Promise<void>;
}

层级 (查看层级一览)

YmxEventEmitter
- YmxEventBus
  - Ymx

索引

方法

emit off on once

方法

emit

emit(data: EmitData): Promise<void>

触发一个事件

参数

data: EmitData

返回 Promise<void>

示例

await ymx.emit({
  eventName: 'my-event',
  data: 'hello event'
});

示例

await ymx.emit({
  eventName: 'my-once',
  data: 'hello once'
});

off

off(data: UnsubscribeEvent): Promise<void>
取消订阅监听
参数
- data: UnsubscribeEvent
返回 Promise<void>
示例
```
// 移除 my-event 的所有监听器
await ymx.off({
  eventName: 'my-event'
});
```
- 定义于 core.d.ts:3092

on

on(data: SubscribeEvent): Promise<void>
持续订阅监听一个事件
参数
- data: SubscribeEvent
返回 Promise<void>
示例
```
await ymx.on({
  eventName: 'my-event',
  listener: (data) => {
    console.log('event data', data);
  }
});
```
- 定义于 core.d.ts:3060

once

once(data: SubscribeEvent): Promise<void>
订阅监听一个事件，触发一次后失效。
参数
- data: SubscribeEvent
返回 Promise<void>
示例
```
await ymx.once({
  eventName: 'my-once',
  listener: (data) => {
    console.log('once data', data);
  }
});
```
- 定义于 core.d.ts:3077