编程使用
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 相同的选项,并附加一些额外选项:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
dev | boolean | false | 如果设置为 true,Nuxt 将在开发模式下加载。 |
ready | boolean | true | 如果设置为 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 并将其写入项目的 buildDir。
类型
function writeTypes (nuxt?: Nuxt): void
参数
nuxt: 要构建的 Nuxt 实例。可以通过 useNuxt() 调用从上下文中获取。