Skip to content

Commit 824c347

Browse files
authored
docs: rename HotUpdateContext to HotUpdateOptions (#18718)
1 parent 0c658de commit 824c347

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/changes/hotupdate-hook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ interface HmrContext {
2828

2929
This hook is called once for all environments, and the passed modules have mixed information from the Client and SSR environments only. Once frameworks move to custom environments, a new hook that is called for each of them is needed.
3030

31-
The new `hotUpdate` hook works in the same way as `handleHotUpdate` but it is called for each environment and receives a new `HotUpdateContext` instance:
31+
The new `hotUpdate` hook works in the same way as `handleHotUpdate` but it is called for each environment and receives a new `HotUpdateOptions` instance:
3232

3333
```ts
34-
interface HotUpdateContext {
34+
interface HotUpdateOptions {
3535
type: 'create' | 'update' | 'delete'
3636
file: string
3737
timestamp: number

docs/guide/api-environment-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Plugins should set default values using the `config` hook. To configure each env
5858
The `hotUpdate` hook allows plugins to perform custom HMR update handling for a given environment. When a file changes, the HMR algorithm is run for each environment in series according to the order in `server.environments`, so the `hotUpdate` hook will be called multiple times. The hook receives a context object with the following signature:
5959
6060
```ts
61-
interface HotUpdateContext {
61+
interface HotUpdateOptions {
6262
type: 'create' | 'update' | 'delete'
6363
file: string
6464
timestamp: number

packages/vite/src/node/server/hmr.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ export async function handleHMRUpdate(
446446
const options = {
447447
...contextMeta,
448448
modules: [...mods],
449-
// later on hotUpdate will be called for each runtime with a new HotUpdateContext
449+
// later on hotUpdate will be called for each runtime with a new HotUpdateOptions
450450
environment,
451451
}
452452
hotMap.set(environment, { options })

0 commit comments

Comments
 (0)