Skip to content

Commit 0466daf

Browse files
authored
docs: update api-javascript (#647)
1 parent 7053f02 commit 0466daf

File tree

1 file changed

+90
-1
lines changed

1 file changed

+90
-1
lines changed

guide/api-javascript.md

+90-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ const { createServer } = require('vite')
4141
- `configFile`: 使用する設定ファイルを指定します。設定されていない場合、Vite はプロジェクトルートからファイルを自動的に解決しようとします。自動解決を無効にするには `false` に設定します。
4242
- `envFile`: `.env` ファイルを無効にするには `false` に設定します。
4343

44+
## `ResolvedConfig`
45+
46+
`ResolvedConfig` インタフェイスは、`UserConfig` の同一のすべてのプロパティを持ちます。ただし、ほとんどの値は解決済みで undefined ではありません。次のようなユーティリティも含んでいます:
47+
- `config.assetsInclude`: `id` がアセットとしてみなされるかどうかをチェックする関数。
48+
- `config.logger`: Vite の内部的なロガーオブジェクト。
49+
4450
## `ViteDevServer`
4551

4652
```ts
@@ -184,12 +190,74 @@ const { preview } = require('vite')
184190
async function resolveConfig(
185191
inlineConfig: InlineConfig,
186192
command: 'build' | 'serve',
187-
defaultMode?: string
193+
defaultMode = 'development'
188194
): Promise<ResolvedConfig>
189195
```
190196

191197
`command` の値は、開発時(CLI`vite``vite dev``vite serve` がエイリアス)は `serve` になります。
192198

199+
## `mergeConfig`
200+
201+
**型シグネチャ:**
202+
203+
```ts
204+
function mergeConfig(
205+
defaults: Record<string, any>,
206+
overrides: Record<string, any>,
207+
isRoot = true
208+
): Record<string, any>
209+
```
210+
211+
2 つの Vite の設定をディープマージします。`isRoot` はマージされる Vite の設定内の階層を表します。例えば、2 つの `build` オプションをマージする場合は `false` にします。
212+
213+
## `searchForWorkspaceRoot`
214+
215+
**型シグネチャ:**
216+
217+
```ts
218+
function searchForWorkspaceRoot(
219+
current: string,
220+
root = searchForPackageRoot(current)
221+
): string
222+
```
223+
224+
**関連:** [server.fs.allow](/config/server-options.md#server-fs-allow)
225+
226+
条件を満せば、ワークスペースの候補のルートを検索します。そうでなければ、`root` にフォールバックします:
227+
228+
- `package.json``workspaces` フィールドが含まれている
229+
- 以下のいずれかのファイルを含んでいる
230+
- `lerna.json`
231+
- `pnpm-workspace.yaml`
232+
233+
## `loadEnv`
234+
235+
**型シグネチャ:**
236+
237+
```ts
238+
function loadEnv(
239+
mode: string,
240+
envDir: string,
241+
prefixes: string | string[] = 'VITE_'
242+
): Record<string, string>
243+
```
244+
245+
**関連:** [`.env` Files](./env-and-mode.md#env-files)
246+
247+
`envDir` 内の `.env` ファイルを読み込みます。デフォルトでは `prefixes` が変更されない限り、`VITE_` のプレフィックスのある環境変数のみが読み込まれます。
248+
249+
## `normalizePath`
250+
251+
**型シグネチャ:**
252+
253+
```ts
254+
function normalizePath(id: string): string
255+
```
256+
257+
**関連:** [Path Normalization](./api-plugin.md#path-normalization)
258+
259+
Vite プラグイン間で相互運用するためにパスを正規化します。
260+
193261
## `transformWithEsbuild`
194262

195263
**型シグネチャ:**
@@ -202,3 +270,24 @@ async function transformWithEsbuild(
202270
inMap?: object
203271
): Promise<ESBuildTransformResult>
204272
```
273+
274+
esbuildJavaScriptTypeScript を変換します。Vite の内部での esbuild の変換に合わせたいプラグインにとって有用です。
275+
276+
## `loadConfigFromFile`
277+
278+
**型シグネチャ:**
279+
280+
```ts
281+
async function loadConfigFromFile(
282+
configEnv: ConfigEnv,
283+
configFile?: string,
284+
configRoot: string = process.cwd(),
285+
logLevel?: LogLevel
286+
): Promise<{
287+
path: string
288+
config: UserConfig
289+
dependencies: string[]
290+
} | null>
291+
```
292+
293+
esbuildVite の設定ファイルを手動で読み込みます。

0 commit comments

Comments
 (0)