程序化使用

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 相同的选项,并添加了一些额外的选项:

属性类型是否必需描述
devbooleanfalse如果设置为 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: 要传递给 c12loadConfig 调用的选项。

writeTypes

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

类型

function writeTypes (nuxt?: Nuxt): void

参数

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