chore: use mitt hook

This commit is contained in:
AkaraChen 2024-11-14 11:04:41 +08:00
parent 300cd675c6
commit 1aed0fe5d6
3 changed files with 83 additions and 0 deletions

74
web/hooks/use-mitt.ts Normal file
View File

@ -0,0 +1,74 @@
import type { Emitter, EventType, Handler, WildcardHandler } from 'mitt'
import create from 'mitt'
import { useEffect, useRef } from 'react'
const merge = <T extends Record<string, any>>(
...args: Array<T | undefined>
): T => {
return Object.assign({}, ...args)
}
export type _Events = Record<EventType, unknown>
export type UseSubcribeOption = {
/**
* Whether the subscription is enabled.
* @default true
*/
enabled: boolean;
}
export type ExtendedOn<Events extends _Events> = {
<Key extends keyof Events>(
type: Key,
handler: Handler<Events[Key]>,
options?: UseSubcribeOption,
): void;
(
type: '*',
handler: WildcardHandler<Events>,
option?: UseSubcribeOption,
): void;
}
export type UseMittReturn<Events extends _Events> = {
useSubcribe: ExtendedOn<Events>;
emit: Emitter<Events>['emit'];
}
const defaultSubcribeOption: UseSubcribeOption = {
enabled: true,
}
function useMitt<Events extends _Events>(
mitt?: Emitter<Events>,
): UseMittReturn<Events> {
const emitterRef = useRef<Emitter<Events>>()
if (!emitterRef.current)
emitterRef.current = mitt ?? create<Events>()
if (mitt && emitterRef.current !== mitt) {
emitterRef.current.off('*')
emitterRef.current = mitt
}
const emitter = emitterRef.current
const useSubcribe: ExtendedOn<Events> = (
type: string,
handler: any,
option?: UseSubcribeOption,
) => {
const { enabled } = merge(defaultSubcribeOption, option)
useEffect(() => {
if (enabled) {
emitter.on(type, handler)
return () => emitter.off(type, handler)
}
})
}
return {
emit: emitter.emit,
useSubcribe,
}
}
export { useMitt }

View File

@ -70,6 +70,7 @@
"lodash-es": "^4.17.21",
"mermaid": "10.9.3",
"mime": "^4.0.4",
"mitt": "^3.0.1",
"negotiator": "^0.6.3",
"next": "^14.2.10",
"pinyin-pro": "^3.25.0",

View File

@ -151,6 +151,9 @@ importers:
mime:
specifier: ^4.0.4
version: 4.0.4
mitt:
specifier: ^3.0.1
version: 3.0.1
negotiator:
specifier: ^0.6.3
version: 0.6.4
@ -6129,6 +6132,9 @@ packages:
resolution: {integrity: sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==}
engines: {node: '>=16 || 14 >=14.17'}
mitt@3.0.1:
resolution: {integrity: sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==}
mkdirp@0.5.6:
resolution: {integrity: sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==}
hasBin: true
@ -15636,6 +15642,8 @@ snapshots:
minipass@7.1.2: {}
mitt@3.0.1: {}
mkdirp@0.5.6:
dependencies:
minimist: 1.2.8