From 23e23c86019251b40153cf532fe58347c91d437a Mon Sep 17 00:00:00 2001
From: TAKAHASHI Shuuji <shuuji3@gmail.com>
Date: Wed, 19 Mar 2025 22:58:36 +0900
Subject: [PATCH] feat(types): type hints for hmr events
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
resolve #1885
https://github.com/vitejs/vite/commit/95424b26892b005f438169d0ea426cb1a3176bf2 の反映です。
---
guide/api-hmr.md | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/guide/api-hmr.md b/guide/api-hmr.md
index 18c509ab..109f0643 100644
--- a/guide/api-hmr.md
+++ b/guide/api-hmr.md
@@ -10,7 +10,10 @@ Vite は特別な `import.meta.hot` オブジェクトを介して、マニュ
```ts twoslash
import type { ModuleNamespace } from 'vite/types/hot.d.ts'
-import type { InferCustomEventPayload } from 'vite/types/customEvent.d.ts'
+import type {
+ CustomEventName,
+ InferCustomEventPayload,
+} from 'vite/types/customEvent.d.ts'
// ---cut---
interface ImportMeta {
@@ -32,15 +35,18 @@ interface ViteHotContext {
prune(cb: (data: any) => void): void
invalidate(message?: string): void
- on<T extends string>(
+ on<T extends CustomEventName>(
event: T,
cb: (payload: InferCustomEventPayload<T>) => void,
): void
- off<T extends string>(
+ off<T extends CustomEventName>(
event: T,
cb: (payload: InferCustomEventPayload<T>) => void,
): void
- send<T extends string>(event: T, data?: InferCustomEventPayload<T>): void
+ send<T extends CustomEventName>(
+ event: T,
+ data?: InferCustomEventPayload<T>,
+ ): void
}
```