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

Исходники
Nuxt Kit предоставляет набор утилит, помогающих работать с Nuxt программно. Эти функции позволяют загружать Nuxt, собирать Nuxt и загружать конфигурацию Nuxt.

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

loadNuxt

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

Тип

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

Параметры

loadOptions: Loading conditions for Nuxt. loadNuxt uses c12 under the hood, so it accepts the same options as c12.loadConfig with some additional options:

PropertyTypeRequiredDescription
devbooleanfalseIf set to true, Nuxt will be loaded in development mode.
readybooleantrueIf set to true, Nuxt will be ready to use after the loadNuxt call. If set to false, you will need to call nuxt.ready() to make sure Nuxt is ready to use.

buildNuxt

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

Тип

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

Параметры

nuxt: Nuxt instance to build. It can be retrieved from the context via useNuxt() call.

loadNuxtConfig

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

Тип

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

Параметры

options: Options to pass in c12 loadConfig call.

writeTypes

Generates tsconfig.json and writes it to the project buildDir.

Тип

function writeTypes (nuxt?: Nuxt): void

Параметры

nuxt: Nuxt instance to build. It can be retrieved from the context via useNuxt() call.