プログラムによる使用は、例えば CLI ツール や テストユーティリティ を構築する際に、Nuxt をプログラムで使用したい場合に役立ちます。

loadNuxt

Nuxt をプログラムで読み込みます。Nuxt の設定を読み込み、インスタンス化し、Nuxt インスタンスを持つプロミスを返します。

型

function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>

パラメータ

loadOptions: Nuxt の読み込み条件。loadNuxt は内部で c12 を使用しているため、c12.loadConfig と同じオプションを受け入れ、いくつかの追加オプションがあります:

buildNuxt

Nuxt をプログラムでビルドします。ビルダー（現在は @nuxt/vite-builder または @nuxt/webpack-builder）を呼び出してアプリケーションをバンドルします。

型

function buildNuxt (nuxt: Nuxt): Promise<any>

パラメータ

nuxt: ビルドする Nuxt インスタンス。コンテキストから useNuxt() 呼び出しを通じて取得できます。

loadNuxtConfig

Nuxt 設定を読み込みます。設定オブジェクトを持つプロミスを返します。

型

function loadNuxtConfig (options: LoadNuxtConfigOptions): Promise<NuxtOptions>

パラメータ

options: c12 の loadConfig 呼び出しに渡すオプション。

writeTypes

tsconfig.json を生成し、プロジェクトの buildDir に書き込みます。

型

function writeTypes (nuxt?: Nuxt): void

パラメータ

nuxt: ビルドする Nuxt インスタンス。コンテキストから useNuxt() 呼び出しを通じて取得できます。