useEventBus

分类

实用工具

导出大小

282 B

上次更改

3 个月前

一个基本的事件总线。

演示

源码在线演练 (beta)

新闻频道

电视

--- 无信号 ---

用法

TypeScript

import { useEventBus
 } from '@vueuse/core'

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

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

// listen to an event
const unsubscribe
 = bus
.on
(listener
)

// fire an event
bus
.emit
('The Tokyo Olympics has begun')

// unregister the listener
unsubscribe
()
// or
bus
.off
(listener
)

// clearing all listeners
bus
.reset
()

import { useEventBus } from '@vueuse/core'
const bus = useEventBus('news')
function listener(event) {
  console.log(`news: ${event}`)
}
// listen to an event
const unsubscribe = bus.on(listener)
// fire an event
bus.emit('The Tokyo Olympics has begun')
// unregister the listener
unsubscribe()
// or
bus.off(listener)
// clearing all listeners
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` will be `{ 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
> {
  /**
   * Subscribe to an event. When calling emit, the listeners will execute.
   * @param listener watch listener.
   * @returns a stop function to remove the current callback.
   */
  on
: (listener
: EventBusListener
<T
, P
>) => Fn

  /**
   * Similar to `on`, but only fires once
   * @param listener watch listener.
   * @returns a stop function to remove the current callback.
   */
  once
: (listener
: EventBusListener
<T
, P
>) => Fn

  /**
   * Emit an event, the corresponding event listeners will execute.
   * @param event data sent.
   */
  emit
: (event
?: T
, payload
?: P
) => void
  /**
   * Remove the corresponding listener.
   * @param listener watch listener.
   */
  off
: (listener
: EventBusListener
<T
>) => void
  /**
   * Clear all events
   */
  reset
: () => void
}
export declare function useEventBus
<T
 = unknown, P
 = any>(
  key
: EventBusIdentifier
<T
>,
): UseEventBusReturn
<T
, P
>