From 2359004ecedd85fb9a95f64f798ae9a24ded74d1 Mon Sep 17 00:00:00 2001 From: Jun Shindo <46585162+jay-es@users.noreply.github.com> Date: Sat, 30 Aug 2025 11:32:34 +0900 Subject: [PATCH] docs: clarify kind for `hotUpdate` / `handleHotUpdate` hooks --- guide/api-environment-plugins.md | 1 + guide/api-plugin.md | 1 + 2 files changed, 2 insertions(+) diff --git a/guide/api-environment-plugins.md b/guide/api-environment-plugins.md index 54d05f71..453cfeba 100644 --- a/guide/api-environment-plugins.md +++ b/guide/api-environment-plugins.md @@ -71,6 +71,7 @@ Vite サーバーには共有プラグインパイプラインがありますが ## `hotUpdate` フック {#the-hotupdate-hook} - **型:** `(this: { environment: DevEnvironment }, options: HotUpdateOptions) => Array | void | Promise | void>` +- **種類:** `async`、`sequential` - **参照:** [HMR API](./api-hmr) `hotUpdate` フックを使用すると、プラグインが指定された環境に対してカスタム HMR 更新処理を実行できるようになります。ファイルが変更されると、HMR アルゴリズムは `server.environments` の順番に従って各環境で順に実行されるので、`hotUpdate` フックは複数回呼び出されることになります。このフックは以下のシグネチャを持つコンテキストオブジェクトを受け取ります: diff --git a/guide/api-plugin.md b/guide/api-plugin.md index fffaad7a..af27d7f2 100644 --- a/guide/api-plugin.md +++ b/guide/api-plugin.md @@ -403,6 +403,7 @@ Vite プラグインは Vite 特有の目的を果たすフックを提供する ### `handleHotUpdate` - **型:** `(ctx: HmrContext) => Array | void | Promise | void>` +- **種類:** `async`、`sequential` - **参照:** [HMR API](./api-hmr) カスタム HMR 更新処理を実行します。このフックは以下のシグネチャーのコンテキストオブジェクトを受け取ります: