Программное использование
Программный API удобен при разработке CLI, тестовых утилит и других инструментов поверх Nuxt.
loadNuxt
Загружает Nuxt программно: читает конфигурацию, создаёт экземпляр и возвращает промис с ним.
Тип
function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
Параметры
loadOptions: параметры загрузки Nuxt. loadNuxt внутри опирается на c12, поэтому принимает те же опции, что и c12.loadConfig, плюс дополнительные:
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
dev | boolean | false | При true Nuxt загружается в режиме разработки. |
ready | boolean | true | При true после loadNuxt экземпляр уже готов к работе. При 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: аргументы для loadConfig из c12.
writeTypes
Генерирует tsconfig.json и записывает его в buildDir проекта.
Тип
function writeTypes (nuxt?: Nuxt): void
Параметры
nuxt: экземпляр Nuxt. Его можно получить из контекста через useNuxt().