nuxt logo

Traducción de Documentación (No Oficial)

Uso Programático

Nuxt Kit proporciona un conjunto de utilidades para ayudarte a trabajar con Nuxt de manera programática. Estas funciones te permiten cargar Nuxt, construir Nuxt y cargar la configuración de Nuxt.

El uso programático puede ser útil cuando deseas usar Nuxt de manera programática, por ejemplo, al construir una herramienta CLI o utilidades de prueba.

loadNuxt

Carga Nuxt de manera programática. Cargará la configuración de Nuxt, instanciará y devolverá la promesa con la instancia de Nuxt.

Tipo

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

Parámetros

loadOptions: Condiciones de carga para Nuxt. loadNuxt utiliza c12 internamente, por lo que acepta las mismas opciones que c12.loadConfig con algunas opciones adicionales:

PropiedadTipoRequeridoDescripción
devbooleanfalseSi se establece en true, Nuxt se cargará en modo de desarrollo.
readybooleantrueSi se establece en true, Nuxt estará listo para usar después de la llamada a loadNuxt. Si se establece en false, necesitarás llamar a nuxt.ready() para asegurarte de que Nuxt esté listo para usar.

buildNuxt

Construye Nuxt de manera programática. Invocará al constructor (actualmente @nuxt/vite-builder o @nuxt/webpack-builder) para empaquetar la aplicación.

Tipo

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

Parámetros

nuxt: Instancia de Nuxt para construir. Puede ser recuperada del contexto mediante la llamada a useNuxt().

loadNuxtConfig

Carga la configuración de Nuxt. Devolverá la promesa con el objeto de configuración.

Tipo

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

Parámetros

options: Opciones para pasar en la llamada a loadConfig de c12.

writeTypes

Genera tsconfig.json y lo escribe en el directorio de construcción del proyecto.

Tipo

function writeTypes (nuxt?: Nuxt): void

Parámetros

nuxt: Instancia de Nuxt para construir. Puede ser recuperada del contexto mediante la llamada a useNuxt().