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