useEventBus

类别

Utilities

导出体积

282 B

上次更改

2 months ago

一个基本的事件总线。

示例

源码 playground (beta)

新闻频道：

电视：

--- 无信号 ---

用法

TypeScript

import { useEventBus
 } from '@vueuse/core'

const bus
 = useEventBus
<string>('news')

function listener
(event
: string) {
  console
.log
(`news: ${event
}`)
}

// 监听事件
const unsubscribe
 = bus
.on
(listener
)

// 触发事件
bus
.emit
('东京奥运会已经开始了')

// 注销监听器
unsubscribe
()
// 或者
bus
.off
(listener
)

// 清除所有监听器
bus
.reset
()

import { useEventBus } from '@vueuse/core'
const bus = useEventBus('news')
function listener(event) {
  console.log(`news: ${event}`)
}
// 监听事件
const unsubscribe = bus.on(listener)
// 触发事件
bus.emit('东京奥运会已经开始了')
// 注销监听器
unsubscribe()
// 或者
bus.off(listener)
// 清除所有监听器
bus.reset()

在组件的 setup 内注册的监听器会在组件卸载时自动注销。

TypeScript

使用 EventBusKey 将事件类型绑定到键上，类似于 Vue 的 InjectionKey 工具。

TypeScript

// fooKey.ts
import type { EventBusKey
 } from '@vueuse/core'

export const fooKey
: EventBusKey
<{ name
: foo
 }> = Symbol
('symbol-key')

export const fooKey = Symbol('symbol-key')

import { useEventBus
 } from '@vueuse/core'

import { fooKey
 } from './fooKey'

const bus
 = useEventBus
(fooKey
)

bus
.on
((e
) => {
  // `e` 是 `{ name: foo }`
})

类型声明

显示类型声明

export type EventBusListener
<T
 = unknown, P
 = any> = (
  event
: T
,
  payload
?: P
,
) => void
export type EventBusEvents
<T
, P
 = any> = Set
<EventBusListener
<T
, P
>>
export interface EventBusKey
<T
> extends Symbol {}
export type EventBusIdentifier
<T
 = unknown> = EventBusKey
<T
> | string | number
export interface UseEventBusReturn
<T
, P
> {
  /**
   * 订阅事件。调用 emit 时，监听器将执行。
   * @param listener 监听器函数。
   * @returns 用于移除当前回调的停止函数。
   */
  on
: (listener
: EventBusListener
<T
, P
>) => Fn

  /**
   * 类似于 `on`，但仅触发一次。
   * @param listener 监听器函数。
   * @returns 用于移除当前回调的停止函数。
   */
  once
: (listener
: EventBusListener
<T
, P
>) => Fn

  /**
   * 发射事件，相应的事件监听器将执行。
   * @param event 发送的数据。
   * @param payload 附带的负载数据。
   */
  emit
: (event
?: T
, payload
?: P
) => void
  /**
   * 移除相应的监听器。
   * @param listener 监听器函数。
   */
  off
: (listener
: EventBusListener
<T
>) => void
  /**
   * 清除所有事件。
   */
  reset
: () => void
}
export declare function useEventBus
<T
 = unknown, P
 = any>(
  key
: EventBusIdentifier
<T
>,
): UseEventBusReturn
<T
, P
>