プログラムによる使用
Nuxt Kitは、Nuxtをプログラムで操作するためのユーティリティセットを提供します。これらの関数を使用すると、Nuxtの読み込み、ビルド、Nuxt設定の読み込みが可能です。
プログラムによる使用は、例えばCLIツールやテストユーティリティを構築する際に、Nuxtをプログラムで使用したい場合に役立ちます。
loadNuxt
Nuxtをプログラムで読み込みます。Nuxtの設定を読み込み、インスタンス化し、Nuxtインスタンスを持つPromiseを返します。
型
function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
パラメータ
loadOptions: Nuxtの読み込み条件。loadNuxtは内部でc12を使用しているため、c12.loadConfigと同じオプションを受け入れ、いくつかの追加オプションがあります：
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
dev | boolean | false | trueに設定すると、Nuxtは開発モードで読み込まれます。 |
ready | boolean | 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()呼び出しを通じて取得できます。