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

loadNuxt

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

型

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設定を読み込みます。設定オブジェクトを持つPromiseを返します。

型

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

パラメータ

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

writeTypes

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

型

function writeTypes (nuxt?: Nuxt): void

パラメータ

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