编程方式使用
编程方式使用在你想以编程方式使用 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,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() 调用从上下文中获取。