Skip to content

Commit 2359004

Browse files
committed
docs: clarify kind for hotUpdate / handleHotUpdate hooks
1 parent 205d27f commit 2359004

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

guide/api-environment-plugins.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ Vite サーバーには共有プラグインパイプラインがありますが
7171
## `hotUpdate` フック {#the-hotupdate-hook}
7272
7373
- **型:** `(this: { environment: DevEnvironment }, options: HotUpdateOptions) => Array<EnvironmentModuleNode> | void | Promise<Array<EnvironmentModuleNode> | void>`
74+
- **種類:** `async`、`sequential`
7475
- **参照:** [HMR API](./api-hmr)
7576
7677
`hotUpdate` フックを使用すると、プラグインが指定された環境に対してカスタム HMR 更新処理を実行できるようになります。ファイルが変更されると、HMR アルゴリズムは `server.environments` の順番に従って各環境で順に実行されるので、`hotUpdate` フックは複数回呼び出されることになります。このフックは以下のシグネチャを持つコンテキストオブジェクトを受け取ります:

guide/api-plugin.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,7 @@ Vite プラグインは Vite 特有の目的を果たすフックを提供する
403403
### `handleHotUpdate`
404404

405405
- **型:** `(ctx: HmrContext) => Array<ModuleNode> | void | Promise<Array<ModuleNode> | void>`
406+
- **種類:** `async``sequential`
406407
- **参照:** [HMR API](./api-hmr)
407408

408409
カスタム HMR 更新処理を実行します。このフックは以下のシグネチャーのコンテキストオブジェクトを受け取ります:

0 commit comments

Comments
 (0)