程序化使用

源文件
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() 调用从上下文中检索。