types: add type for vite:invalidate payload

vitejs · Sep 28, 2022 · f813817 · f813817
1 parent a21886d
commit f813817
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 8 deletions.
diff --git a/packages/vite/src/client-types.d.ts b/packages/vite/src/client-types.d.ts
@@ -1,6 +1,7 @@
 export type {
   CustomEventMap,
-  InferCustomEventPayload
+  InferCustomEventPayload,
+  InvalidatePayload
 } from './types/customEvent'
 export type {
   HMRPayload,

diff --git a/packages/vite/src/client/client.ts b/packages/vite/src/client/client.ts
@@ -548,8 +548,8 @@ export function createHotContext(ownerPath: string): ViteHotContext {
 
     // tell the server to re-perform hmr propagation from this module as root
     invalidate() {
-      notifyListeners('vite:invalidate', ownerPath)
-      this.send('vite:invalidate', ownerPath)
+      notifyListeners('vite:invalidate', { path: ownerPath })
+      this.send('vite:invalidate', { path: ownerPath })
     },
 
     // custom events

diff --git a/packages/vite/src/node/server/index.ts b/packages/vite/src/node/server/index.ts
@@ -13,6 +13,7 @@ import launchEditorMiddleware from 'launch-editor-middleware'
 import type { SourceMap } from 'rollup'
 import picomatch from 'picomatch'
 import type { Matcher } from 'picomatch'
+import type { InvalidatePayload } from 'types/customEvent'
 import type { CommonServerOptions } from '../http'
 import {
   httpServerStart,
@@ -494,8 +495,8 @@ export async function createServer(
     handleFileAddUnlink(normalizePath(file), server)
   })
 
-  ws.on('vite:invalidate', async (url: string) => {
-    const mod = moduleGraph.urlToModuleMap.get(url)
+  ws.on('vite:invalidate', async ({ path }: InvalidatePayload) => {
+    const mod = moduleGraph.urlToModuleMap.get(path)
     if (mod && mod.isSelfAccepting && mod.lastHMRTimestamp > 0) {
       const file = getShortName(mod.file!, config.root)
       updateModules(file, [...mod.importers], mod.lastHMRTimestamp, server)

diff --git a/packages/vite/src/types/customEvent.d.ts b/packages/vite/src/types/customEvent.d.ts
@@ -10,6 +10,11 @@ export interface CustomEventMap {
   'vite:beforePrune': PrunePayload
   'vite:beforeFullReload': FullReloadPayload
   'vite:error': ErrorPayload
+  'vite:invalidate': InvalidatePayload
+}
+
+export interface InvalidatePayload {
+  path: string
 }
 
 export type InferCustomEventPayload<T extends string> =

diff --git a/packages/vite/types/customEvent.d.ts b/packages/vite/types/customEvent.d.ts
@@ -1 +1,5 @@
-export type { CustomEventMap, InferCustomEventPayload } from '../client/types'
+export type {
+  CustomEventMap,
+  InferCustomEventPayload,
+  InvalidatePayload
+} from '../client/types'
diff --git a/playground/hmr/hmr.ts b/playground/hmr/hmr.ts
@@ -89,8 +89,8 @@ if (import.meta.hot) {
     console.log(`>>> vite:error -- ${event.type}`)
   })
 
-  import.meta.hot.on('vite:invalidate', (event) => {
-    console.log(`>>> vite:invalidate -- ${event}`)
+  import.meta.hot.on('vite:invalidate', ({ path }) => {
+    console.log(`>>> vite:invalidate -- ${path}`)
   })
 
   import.meta.hot.on('custom:foo', ({ msg }) => {