Программное использование

Программное использование может быть полезно, когда вы хотите использовать Nuxt программно, например, при создании CLI или тестовых утилит.

loadNuxt

Загружает Nuxt программным способом. Он загрузит конфигурацию Nuxt, инстанцирует и вернет промис с экземпляром Nuxt.

Тип

async function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>

interface LoadNuxtOptions extends LoadNuxtConfigOptions {
  dev?: boolean
  ready?: boolean
}

Параметры

loadOptions

Тип: LoadNuxtOptions

По умолчанию: {}

Условия загрузки для Nuxt. loadNuxt использует c12 под капотом, поэтому принимает те же опции, что и c12.loadConfig с некоторыми дополнительными опциями:

• dev (опциональный)
  Тип: boolean
  По умолчанию: false
  Если установлено true, Nuxt загрузится в dev-режиме.
• ready (опциональный)
  Тип: boolean
  По умолчанию: true
  Если установлено значение true, Nuxt будет готов к использованию после вызова loadNuxt. Если установлено значение false, вам нужно будет вызвать nuxt.ready(), чтобы убедиться, что Nuxt готов к использованию.

buildNuxt

Сборка Nuxt программным способом. Он вызовет сборщик (в настоящее время @nuxt/vite-builder или @nuxt/webpack-builder) для создания бандла приложения.

Тип

async function buildNuxt (nuxt: Nuxt): Promise<any>

Параметры

nuxt

Тип: Nuxt

Обязательный: true

Инстанс Nuxt для сборки. Он может быть получен из контекста с помощью вызова useNuxt().

loadNuxtConfig

Загрузка конфигурации Nuxt. Эта функция вернет промис с объектом конфигурации.

Тип

async function loadNuxtConfig (options: LoadNuxtConfigOptions): Promise<NuxtOptions>

Параметры

options

Тип: LoadNuxtConfigOptions

Обязательный: true

Параметры для передачи в вызове loadConfig от c12.

writeTypes

Генерирует tsconfig.json и записывает его в директорию buildDir проекта.

Тип

function writeTypes (nuxt?: Nuxt): void

interface Nuxt {
  options: NuxtOptions
  hooks: Hookable<NuxtHooks>
  hook: Nuxt['hooks']['hook']
  callHook: Nuxt['hooks']['callHook']
  addHooks: Nuxt['hooks']['addHooks']
  ready: () => Promise<void>
  close: () => Promise<void>
  server?: any
  vfs: Record<string, string>
  apps: Record<string, NuxtApp>
}

Параметры

nuxt

Тип: Nuxt

Обязательный: true

Инстанс Nuxt для сборки. Он может быть получен из контекста с помощью вызова useNuxt().