程序化使用
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 相同的选项以及一些附加选项。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
开发 | boolean | false | 如果设置为 true,Nuxt 将以开发模式加载。 |
ready | boolean | true | 如果设置为 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() 调用从上下文中获取。