Skip to content

docs: align the parameters type of the config hook #2657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jay-es merged 1 commit into from
Jun 23, 2026
Merged

docs: align the parameters type of the config hook #2657

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions guide/api-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Vite プラグインは Vite 特有の目的を果たすフックを提供する

### `config`

- **型:** `(config: UserConfig, env: { mode: string, command: string }) => UserConfig | null | void`
- **型:** `(config: UserConfig, env: { mode: 'build' | 'serve', command: string, isSsrBuild?: boolean, isPreview?: boolean }) => UserConfig | null | void`
- **種類:** `async`, `sequential`

Vite の設定を解決される前に変更します。このフックは生のユーザー設定（CLI オプションが設定ファイルにマージされたもの）と使用されている `mode` と `command` を公開する現在の設定環境を受け取ります。既存の設定に深くマージされる部分的な設定オブジェクトを返したり、設定を直接変更できます（デフォルトのマージで目的の結果が得られない場合）。
Expand Down Expand Up @@ -376,8 +376,9 @@ Vite プラグインは Vite 特有の目的を果たすフックを提供する
path: string
filename: string
server?: ViteDevServer
bundle?: import('rollup').OutputBundle
chunk?: import('rollup').OutputChunk
bundle?: import('rolldown').OutputBundle
chunk?: import('rolldown').OutputChunk
originalUrl?: string
},
) =>
| IndexHtmlTransformResult
Expand Down
Loading