Lzh on GitHub

modules

使用 modules/ 目录来自动注册您应用程序中的本地模块。

在构建应用程序时，这是一个放置您开发的任何本地模块的好地方。

自动注册的文件模式包括：

  • modules/*/index.ts
  • modules/*.ts
  • 您不需要单独将这些本地模块添加到您的 nuxt.config.ts 文件中。
// `nuxt/kit` is a helper subpath import you can use when defining local modules
// that means you do not need to add `@nuxt/kit` to your project's dependencies
import { createResolver, defineNuxtModule, addServerHandler } from 'nuxt/kit'

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

    // Add an API route
    addServerHandler({
      route: '/api/hello',
      handler: resolver.resolve('./runtime/api-route')
    })
  }
})

启动 Nuxt 时，hello 模块将被注册，并且 /api/hello 路由将可用。

模块按以下顺序执行：

  • 首先，加载在 nuxt.config.ts 中定义的模块。
  • 然后，执行在 modules/ 目录中找到的模块，它们按字母顺序加载。
  • 您可以通过在每个目录名称前面添加一个数字来更改本地模块的顺序：
Directory structure
modules/
  1.first-module/
    index.ts
  2.second-module.ts
Read more in Docs > Guide > Going Further > Modules.
观看 Vue School 关于 Nuxt 私有模块的视频。