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 { resolve } = createResolver(import.meta.url)
// Add an API route
addServerHandler({
route: '/api/hello',
handler: resolve('./runtime/api-route')
})
}
})
Nuxtを起動すると、`hello`モジュールが登録され、`/api/hello`ルートが使用可能になります。
モジュールは次の順序で実行されます。
- まず、
nuxt.config.ts
で定義されているモジュールが読み込まれます。 - 次に、`modules/`ディレクトリにあるモジュールが実行され、アルファベット順に読み込まれます。
各ディレクトリ名の前に数字を追加することで、ローカルモジュールの順序を変更できます。
ディレクトリ構造
modules/
1.first-module/
index.ts
2.second-module.ts