Программное использование
Программная работа с Nuxt: загрузка, сборка и конфигурация.
Программное использование пригодится при встраивании Nuxt в CLI или test utils.
loadNuxt
Загружает Nuxt программно: читает конфигурацию, создаёт экземпляр и возвращает промис с ним.
Тип
function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
Параметры
loadOptions: опции загрузки. loadNuxt использует c12, принимает те же опции, что и c12.loadConfig, плюс:
| Свойство | Тип | Обязательный | Описание |
|---|---|---|---|
dev | boolean | нет | true — режим разработки. |
ready | boolean | по умолч. true | true — Nuxt считается готовым после вызова. false — нужно вызвать nuxt.ready(). |
buildNuxt
Сборка Nuxt программно: запускает билдер (@nuxt/vite-builder или @nuxt/webpack-builder) для сборки приложения.
Тип
function buildNuxt (nuxt: Nuxt): Promise<any>
Параметры
nuxt: экземпляр Nuxt для сборки (например из контекста через useNuxt()).
loadNuxtConfig
Загружает конфигурацию Nuxt и возвращает промис с объектом конфигурации.
Тип
function loadNuxtConfig (options: LoadNuxtConfigOptions): Promise<NuxtOptions>
Параметры
options: опции для вызова c12.loadConfig.
writeTypes
Генерирует tsconfig.json и записывает в buildDir проекта.
Тип
function writeTypes (nuxt?: Nuxt): void
Параметры
nuxt: экземпляр Nuxt (например из контекста через useNuxt()).