nuxt logo

Traducción de Documentación (No Oficial)

módulos

Usa el directorio modules/ para registrar automáticamente módulos locales dentro de tu aplicación.

Es un buen lugar para colocar cualquier módulo local que desarrolles mientras construyes tu aplicación.

Los patrones de archivos registrados automáticamente son:

  • modules/*/index.ts
  • modules/*.ts

No necesitas agregar esos módulos locales a tu nuxt.config.ts por separado.

// `nuxt/kit` es una importación de subruta auxiliar que puedes usar al definir módulos locales
// eso significa que no necesitas agregar `@nuxt/kit` a las dependencias de tu proyecto
import { createResolver, defineNuxtModule, addServerHandler } from 'nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'hello'
  },
  setup () {
    const resolver = createResolver(import.meta.url)

    // Añadir una ruta API
    addServerHandler({
      route: '/api/hello',
      handler: resolver.resolve('./runtime/api-route')
    })
  }
})

Al iniciar Nuxt, el módulo hello será registrado y la ruta /api/hello estará disponible.

Los módulos se ejecutan en la siguiente secuencia:

  • Primero, se cargan los módulos definidos en nuxt.config.ts.
  • Luego, se ejecutan los módulos encontrados en el directorio modules/, y se cargan en orden alfabético.

Puedes cambiar el orden de los módulos locales añadiendo un número al frente de cada nombre de directorio:

Estructura del directorio
modules/
  1.first-module/
    index.ts
  2.second-module.ts
Ver también guide > going-further > modules

Mira el video de Vue School sobre módulos privados de Nuxt.