以编程方式使用

源码
Nuxt Kit 提供了一组实用工具,帮助你以编程方式使用 Nuxt。这些函数允许你加载 Nuxt、构建 Nuxt,并加载 Nuxt 配置。

在需要以编程方式使用 Nuxt 时,编程使用非常有用,例如在构建 CLI 工具测试工具 时。

loadNuxt

以编程方式加载 Nuxt。它会加载 Nuxt 配置,实例化并返回包含 Nuxt 实例的 Promise。

Type

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

参数

loadOptions:Nuxt 的加载条件。loadNuxt 在内部使用 c12,因此它接受与 c12.loadConfig 相同的选项,并附加以下选项:

属性类型必需描述
devbooleanfalse如果设置为 true,Nuxt 将以开发模式加载。
readybooleantrue如果设置为 trueloadNuxt 调用后 Nuxt 将可立即使用。如果设置为 false,你需要调用 nuxt.ready() 来确保 Nuxt 可用。

buildNuxt

以编程方式构建 Nuxt。它会调用构建器(当前为 @nuxt/vite-builder@nuxt/webpack-builder)来打包应用程序。

Type

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

参数

nuxt:要构建的 Nuxt 实例。可以通过上下文中的 useNuxt() 调用获取。

loadNuxtConfig

加载 Nuxt 配置。它将返回包含配置对象的 Promise。

Type

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

参数

options:传递给 c12 loadConfig 调用的选项。

writeTypes

生成 tsconfig.json 并将其写入项目的 buildDir。

Type

function writeTypes (nuxt?: Nuxt): void

参数

nuxt:要构建的 Nuxt 实例。可以通过上下文中的 useNuxt() 调用获取。