chore(client)!: remove never implemented hot.decline (#11036)

vitejs · Dec 3, 2022 · e257e3b · e257e3b
1 parent 859fe05
commit e257e3b
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 4 deletions.
diff --git a/docs/guide/api-hmr.md b/docs/guide/api-hmr.md
@@ -30,7 +30,6 @@ interface ViteHotContext {
 
   dispose(cb: (data: any) => void): void
   prune(cb: (data: any) => void): void
-  decline(): void
   invalidate(message?: string): void
 
   // `InferCustomEventPayload` provides types for built-in Vite events
@@ -139,7 +138,7 @@ The `import.meta.hot.data` object is persisted across different instances of the
 
 ## `hot.decline()`
 
-Calling `import.meta.hot.decline()` indicates this module is not hot-updatable, and the browser should perform a full reload if this module is encountered while propagating HMR updates.
+This is currently a noop and is there for backward compatibility. This could change in the future if there is a new usage for it. To indicate that the module is not hot-updatable, use `hot.invalidate()`.
 
 ## `hot.invalidate(message?: string)`
 

diff --git a/packages/vite/src/client/client.ts b/packages/vite/src/client/client.ts
@@ -550,7 +550,8 @@ export function createHotContext(ownerPath: string): ViteHotContext {
       pruneMap.set(ownerPath, cb)
     },
 
-    // TODO
+    // Kept for backward compatibility (#11036)
+    // @ts-expect-error untyped
     // eslint-disable-next-line @typescript-eslint/no-empty-function
     decline() {},
 

diff --git a/packages/vite/types/hot.d.ts b/packages/vite/types/hot.d.ts
@@ -22,7 +22,6 @@ export interface ViteHotContext {
 
   dispose(cb: (data: any) => void): void
   prune(cb: (data: any) => void): void
-  decline(): void
   invalidate(message?: string): void
 
   on<T extends string>(