プログラムによる使用
Nuxt Kit は、Nuxt をプログラムで操作するのに役立つ一連のユーティリティを提供します。これらの関数を使用すると、Nuxt の読み込み、Nuxt のビルド、Nuxt の設定の読み込みを行うことができます。
プログラムによる利用は、例えばCLI ツールまたはテストユーティリティ.
loadNuxt
Nuxt をプログラムで読み込みます。Nuxt の設定を読み込み、Nuxt インスタンスで Promise をインスタンス化して返します。
タイプ
function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
パラメーター
loadOptions: Nuxt の読み込み条件。loadNuxt はc12を内部で使用するため、c12.loadConfig と同じオプションに加えていくつかの追加オプションを受け入れます。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
dev | ブール値 | false | true に設定すると、Nuxt は開発モードで読み込まれます。 |
ready | ブール値 | true | true に設定すると、loadNuxt の呼び出し後、Nuxt はすぐに使用できる状態になります。false に設定すると、Nuxt を使用できる状態にするために nuxt.ready() を呼び出す必要があります。 |
buildNuxt
Nuxt をプログラムでビルドします。ビルダー(現在@nuxt/vite-builderまたは@nuxt/webpack-builder)を起動してアプリケーションをバンドルします。
タイプ
function buildNuxt (nuxt: Nuxt): Promise<any>
パラメーター
nuxt: ビルドする Nuxt インスタンス。useNuxt() の呼び出しを介してコンテキストから取得できます。
loadNuxtConfig
Nuxt の設定を読み込みます。設定オブジェクトを含む Promise を返します。
タイプ
function loadNuxtConfig (options: LoadNuxtConfigOptions): Promise<NuxtOptions>
パラメーター
options: に渡すオプションc12 loadConfig の呼び出し。
writeTypes
tsconfig.json を生成し、プロジェクトの buildDir に書き込みます。
タイプ
function writeTypes (nuxt?: Nuxt): void
パラメーター
nuxt: ビルドする Nuxt インスタンス。useNuxt() の呼び出しを介してコンテキストから取得できます。