Programmatic Usage
Nuxt Kit 提供了一系列工具,帮助你以编程方式使用 Nuxt。这些函数允许你加载 Nuxt、构建 Nuxt,以及加载 Nuxt 配置。
当你想以编程方式使用 Nuxt 时,这种编程式用法会很有帮助,例如,在构建 CLI 工具 或 test utils 时。
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() 调用从上下文中获取。