MpxUseuseEventBus
一个基础的 event bus.
用法
ts
import { useEventBus } from '@mpxjs/mpxuse-core'
const bus = useEventBus<string>('news')
const 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 '@mpxjs/mpxuse-core'
const bus = useEventBus<string>('news')
const 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()
卸载组件时，在组件“setup”内部注册的侦听器将自动注销。
Type Declarations
Show Type Declarations
typescript
export declare type EventBusListener<T = unknown, P = any> = (
event: T,
payload?: P
) => void
export declare type EventBusEvents<T, P = any> = EventBusListener<T, P>[]
export declare type EventBusKey<T> = symbol
export declare 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>
export declare type EventBusListener<T = unknown, P = any> = (
event: T,
payload?: P
) => void
export declare type EventBusEvents<T, P = any> = EventBusListener<T, P>[]
export declare type EventBusKey<T> = symbol
export declare 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>
源码
贡献者
pagnkelly