From b629910427584b625e9a252779848d03bd2088f3 Mon Sep 17 00:00:00 2001 From: Jun Shindo <46585162+jay-es@users.noreply.github.com> Date: Thu, 21 Nov 2024 00:36:59 +0900 Subject: [PATCH] docs: rename `HotUpdateContext` to `HotUpdateOptions` --- changes/hotupdate-hook.md | 4 ++-- guide/api-environment-plugins.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/changes/hotupdate-hook.md b/changes/hotupdate-hook.md index c3decb0a..715482ad 100644 --- a/changes/hotupdate-hook.md +++ b/changes/hotupdate-hook.md @@ -28,10 +28,10 @@ interface HmrContext { このフックはすべての環境に対して一度だけ呼び出され、渡されたモジュールはクライアント環境と SSR 環境だけの情報が混在しています。フレームワークがカスタム環境に移行すると、それぞれの環境に対して呼び出される新しいフックが必要になります。 -新しい `hotUpdate` フックは `handleHotUpdate` と同じように動作しますが、環境ごとに呼び出され、新しい `HotUpdateContext` インスタンスを受け取ります: +新しい `hotUpdate` フックは `handleHotUpdate` と同じように動作しますが、環境ごとに呼び出され、新しい `HotUpdateOptions` インスタンスを受け取ります: ```ts -interface HotUpdateContext { +interface HotUpdateOptions { type: 'create' | 'update' | 'delete' file: string timestamp: number diff --git a/guide/api-environment-plugins.md b/guide/api-environment-plugins.md index c3c0cbc2..0b0653e5 100644 --- a/guide/api-environment-plugins.md +++ b/guide/api-environment-plugins.md @@ -58,7 +58,7 @@ Vite サーバーには共有プラグインパイプラインがありますが `hotUpdate` フックを使用すると、プラグインが指定された環境に対してカスタム HMR 更新処理を実行できるようになります。ファイルが変更されると、HMR アルゴリズムは `server.environments` の順番に従って各環境で順に実行されるので、`hotUpdate` フックは複数回呼び出されることになります。このフックは以下のシグネチャを持つコンテキストオブジェクトを受け取ります: ```ts -interface HotUpdateContext { +interface HotUpdateOptions { type: 'create' | 'update' | 'delete' file: string timestamp: number