程式化使用
Nuxt Kit 提供了一組工具，可協助您以程式化的方式使用 Nuxt。這些函式可讓您載入 Nuxt、建置 Nuxt 以及載入 Nuxt 配置。
當您想要以程式化的方式使用 Nuxt 時，例如在建置 CLI 工具或 測試工具時，程式化使用可能會很有幫助。
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，Nuxt 將在loadNuxt呼叫後準備好使用。如果設定為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() 呼叫從上下文中檢索。