当您希望以编程式方式使用 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 并将其写入项目构建目录。
function writeTypes (nuxt?: Nuxt): void
nuxt:要构建的 Nuxt 实例。可以通过 useNuxt() 调用从上下文中检索。