程式化使用

原始檔
Nuxt Kit 提供了一套實用工具，可幫助您以程式化方式使用 Nuxt。這些函式允許您載入 Nuxt、構建 Nuxt 和載入 Nuxt 配置。

當您想以程式化方式使用 Nuxt 時，程式化使用會很有幫助，例如，在構建CLI 工具或測試工具.

loadNuxt

以程式化方式載入 Nuxt。它將載入 Nuxt 配置，例項化並返回帶有 Nuxt 例項的 Promise。

型別

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

引數

loadOptions: Nuxt 的載入條件。loadNuxt 在底層使用了c12，因此它接受與 c12.loadConfig 相同的選項以及一些附加選項

屬性型別必需描述
開發booleanfalse如果設定為 true，Nuxt 將在開發模式下載入。
readybooleantrue如果設定為 true，Nuxt 將在 loadNuxt 呼叫後準備就緒。如果設定為 false，您需要呼叫 nuxt.ready() 來確保 Nuxt 準備就緒。

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() 呼叫從上下文中檢索。