v3.17
Nuxt on GitHub

程序化使用

源代码
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，在调用 loadNuxt 后 Nuxt 将准备好使用。如果设置为 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 并将其写入项目构建目录。

类型

function writeTypes (nuxt?: Nuxt): void

参数

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