ModuleContainer クラス

すべての モジュールModuleContainer インスタンスのコンテキスト内で呼び出されます。

Tapable プラグイン

特定のライフサイクルイベントでのフックを登録できます。

nuxt.moduleContainer.plugin('ready', async moduleContainer => {
    // すべてのモジュールの準備ができたらここを実行します
})

モジュール コンテキストの中では代わりに以下のようにできます:

this.plugin('ready', async moduleContainer => {
    // すべてのモジュールの準備ができたらここを実行します
})
プラグイン 引数 タイミング
ready moduleContainer nuxt.config.js にあるすべてのモジュールが初期化されたとき

メソッド

addVendor (vendor)

vendor は使われなくなったため非推奨です

options.build.vendor に追加し、一意なフィルターを適用します。

addTemplate (template)

  • テンプレート: String または Object
    • src
    • options
    • fileName

プロジェクトの buildDir (.nuxt) へのビルド中に、lodash template を使って与えられたテンプレートをレンダリングします。

fileName を与えない、または template が文字列の場合、ファイル名はデフォルトで [dirName].[fileName].[pathHash].[ext] となります。

このメソッドは最終的な { dist, src, options } オブジェクトを返します。

addPlugin (template)

addTemplate でプラグインを登録し、plugins[] オプションの先頭に追加します。

template.ssr: false を使って SSR バンドルを含むプラグインを無効化することができます。

addServerMiddleware (middleware)

options.serverMiddleware にミドルウェアをプッシュします。

extendBuild (fn)

options.build.extend 関数をチェーンさせることで webpack のビルド設定を簡単に拡張できます。

extendRoutes (fn)

options.build.extendRoutes 関数をチェーンさせることで routes を簡単に拡張できます。

addModule (moduleOpts, requireOnce)

モジュールを登録します。moduleOpts は文字列または [src, options] です。requireOncetrue で解決されたモジュールが meta をエクスポートしている場合に、同じモジュールを二度登録するのを回避します。

requireModule (moduleOpts)

addModule(moduleOpts, true) の短縮形です。

フック

特定のライフサイクルイベントでのフックを登録できます。

フック 引数 タイミング
modules:before (moduleContainer, options) ModuleContainer クラスが作られる前に呼ばれ、メソッドとオプションのオーバーロードに役立ちます。
modules:done (moduleContainer) すべてのモジュールがロードされたときに呼ばれます。

間違いを見つけた、またはドキュメントに貢献したいですか? GitHub でこのページを編集する