プログラムによる使用方法

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

loadNuxt

Nuxtをプログラム的に読み込みます。Nuxtの設定を読み込み、インスタンス化し、Nuxtインスタンスを含むPromiseを返します。

型

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

interface LoadNuxtOptions extends LoadNuxtConfigOptions {
  dev?: boolean
  ready?: boolean
}

パラメータ

loadOptions

型: LoadNuxtOptions

デフォルト: {}

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

• dev (オプション)
  型: boolean
  デフォルト: false
trueに設定すると、Nuxtは開発モードで読み込まれます。
• ready (オプション)
  型: boolean
  デフォルト: true
trueに設定すると、loadNuxt呼び出し後、Nuxtはすぐに使用できるようになります。falseに設定した場合は、nuxt.ready()を呼び出してNuxtが使用できる状態にする必要があります。

buildNuxt

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

型

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

パラメータ

nuxt

型: Nuxt

必須: true

ビルドするNuxtインスタンス。useNuxt()呼び出しによってコンテキストから取得できます。

loadNuxtConfig

Nuxtの設定を読み込みます。設定オブジェクトを含むPromiseを返します。

型

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

パラメータ

options

型: LoadNuxtConfigOptions

必須: true

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

writeTypes

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

型

function writeTypes (nuxt?: Nuxt): void

interface Nuxt {
  options: NuxtOptions
  hooks: Hookable<NuxtHooks>
  hook: Nuxt['hooks']['hook']
  callHook: Nuxt['hooks']['callHook']
  addHooks: Nuxt['hooks']['addHooks']
  ready: () => Promise<void>
  close: () => Promise<void>
  server?: any
  vfs: Record<string, string>
  apps: Record<string, NuxtApp>
}

パラメータ

nuxt

型: Nuxt

必須: true

ビルドするNuxtインスタンス。useNuxt()呼び出しによってコンテキストから取得できます。