本文へ移動

設定項目

項目デフォルト説明
rootstringなし相対パスの基準。プログラム利用では必須、CLI 利用では自動設定
publicstring"../public/main"静的ファイルディレクトリ。root からの相対パスまたは絶対パス
apistring"/api"HTTP API を mount するパス
portnumber30000〜65535 の整数。0 なら OS が空きポートを割り当てる
middlewaresexpress.RequestHandler[][]API・静的配信より前に追加する Express middleware
lanbooleanfalsetrue なら 0.0.0.0false なら 127.0.0.1 で待ち受ける
qrbooleanfalseNetwork URL の QR コードをターミナルへ表示
browserboolean | "local" | "lan"false起動後に開く URL。true"local" と同じ
autoPortbooleanfalse使用中ならポート番号を 1 ずつ増やして空きを探す
signalClosebooleantrueSIGINT / SIGTERM で停止処理を実行
languagestring"ja-JP"サーバーと CLI のメッセージ言語

browser

動作
false開かない
trueLocal URL を開く
"local"Local URL を開く
"lan"lan: true なら Network URL、そうでなければ警告して Local URL を開く

autoPort

指定ポートが使用中で autoPort: true の場合、利用可能になるまでポート番号を 1 ずつ増やします。false の場合は次のポートを使用するか対話で確認し、拒否されると起動に失敗します。

起動後の getPort() は実際に使われたポートを返します。

検証

defineConfig() は Zod スキーマで設定を検証し、不正な型・範囲・未知の設定名では ZodError を投げます。TypeScriptでは未知の設定名も型エラーになります。