ライフサイクルフック

Nuxt は、フックを使用してほぼすべての側面を拡張するための強力なフックシステムを提供します。
Docs > 4 X > Guide > Going Further > Hooks で詳細をご覧ください。

アプリケーションフック(ランタイム)

すべての利用可能なフックについては、アプリケーションソースコードをご確認ください。

フック引数環境説明
app:createdvueAppサーバー&クライアント最初の vueApp インスタンスが作成されたときに呼び出されます。
app:errorerrサーバー&クライアント致命的なエラーが発生したときに呼び出されます。
app:error:cleared{ redirect? }サーバー&クライアント致命的なエラーが発生したときに呼び出されます。
vue:setup-サーバー&クライアントNuxt ルートのセットアップが初期化されたときに呼び出されます。このコールバックは同期である必要があります。
vue:errorerr, target, infoサーバー&クライアントVue のエラーがルートコンポーネントに伝播したときに呼び出されます。さらに学ぶ.
app:renderedrenderContextサーバーSSR レンダリングが完了したときに呼び出されます。
app:redirected-サーバーSSR リダイレクトの前に呼び出されます。
app:beforeMountvueAppクライアントアプリのマウント前に呼び出され、クライアント側でのみ呼び出されます。
app:mountedvueAppクライアントVue アプリがブラウザで初期化され、マウントされたときに呼び出されます。
app:suspense:resolveappComponentクライアントSuspenseの resolved イベントで呼び出されます。resolved event.
app:manifest:update{ id, timestamp }クライアント新しいバージョンのアプリが検出されたときに呼び出されます。
app:data:refreshkeys?クライアントrefreshNuxtData が呼び出されたときに呼び出されます。
link:prefetch@BobbieGoedeクライアント<NuxtLink> がプリフェッチされると監視されたときに呼び出されます。
page:startpageComponent?クライアントNuxtPage の pending イベント内で呼び出されます。の resolved イベントで呼び出されます。inside of NuxtPage pending event.
page:finishpageComponent?クライアントNuxtPage の pending イベント内で呼び出されます。の resolved イベントで呼び出されます。NuxtPage の resolved イベント内で呼び出されます。
page:loading:start-クライアント新しいページの setup() が実行されているときに呼び出されます。
page:loading:end-クライアントpage:finish の後に呼び出されます。
page:transition:finishpageComponent?クライアントページ遷移後のonAfterLeaveイベントで呼び出されます。
dev:ssr-logslogsクライアントクライアントに渡されたサーバーサイドログの配列とともに呼び出されます(features.devLogs が有効な場合)。
page:view-transition:starttransitionクライアント実験的な View Transition サポートが有効になっている場合に、document.startViewTransition が呼び出された後に呼び出されます。

Nuxt フック(ビルド時)

すべての利用可能なフックについては、スキーマソースコードをご確認ください。

フック引数説明
kit:compatibilitycompatibility, issues互換性チェックの拡張を可能にします。
readynuxtNuxt インスタンスが動作準備完了になった後、Nuxt の初期化後に呼び出されます。
closenuxtNuxt インスタンスが正常に終了するときに呼び出されます。
restart{ hard?: boolean }現在の Nuxt インスタンスを再起動するために呼び出されます。
modules:before-Nuxt の初期化中、ユーザーモジュールがインストールされる前に呼び出されます。
modules:done-Nuxt の初期化中、ユーザーモジュールがインストールされた後に呼び出されます。
app:resolveappapp インスタンスの解決後に呼び出されます。
app:templatesappNuxtApp 生成中に呼び出され、ビルドディレクトリ(仮想的または .nuxt に書き込まれる)に新しいファイルをカスタマイズ、変更、追加することを可能にします。
app:templatesGeneratedappテンプレートが仮想ファイルシステム(vfs)にコンパイルされた後に呼び出されます。
build:before-Nuxt バンドルビルダーの前に呼び出されます。
build:done-Nuxt バンドルビルダーが完了した後に呼び出されます。
build:manifestmanifestVite と webpack によるマニフェストビルド中に呼び出されます。これにより、Nitro が最終的な HTML で <script> および <link> タグをレンダリングするために使用するマニフェストをカスタマイズできます。
builder:generateAppoptionsアプリ生成の前に呼び出されます。
builder:watchevent, path開発中のビルド時、ウォッチャーがプロジェクト内のファイルまたはディレクトリの変更を検出したときに呼び出されます。
pages:extendpagesファイルシステムからページルートがスキャンされた後に呼び出されます。
pages:resolvedpagesページルートがスキャンされたメタデータで拡張された後に呼び出されます。
pages:routerOptions{ files: Array<{ path: string, optional?: boolean }> }router.options ファイルを解決するときに呼び出されます。配列の後ろにある項目は前の項目を上書きします。
server:devHandlerhandlerNitro 開発サーバーに開発ミドルウェアが登録されているときに呼び出されます。
imports:sourcespresetsセットアップ時に呼び出され、モジュールがソースを拡張できるようにします。
imports:extendimportsセットアップ時に呼び出され、モジュールがインポートを拡張できるようにします。
imports:contextcontextunimportコンテキストが作成されたときに呼び出されます。context is created.
imports:dirsdirsインポートディレクトリの拡張を可能にします。
components:dirsdirsapp:resolve 内で呼び出され、自動インポート可能なコンポーネントがスキャンされるディレクトリを拡張できます。
components:extendcomponents新しいコンポーネントの拡張を可能にします。
nitro:confignitroConfigNitro の初期化前に呼び出され、Nitro の構成をカスタマイズできます。
nitro:initニトロNitro が初期化された後に呼び出され、Nitro フックの登録や Nitro と直接のやり取りを可能にします。
nitro:build:beforeニトロNitro インスタンスのビルド前に呼び出されます。
nitro:build:public-assetsニトロパブリックアセットのコピー後に呼び出されます。Nitro サーバーがビルドされる前にパブリックアセットを変更できます。
prerender:routesctxプリレンダリングされるルートの拡張を可能にします。
build:errorerrorビルド時にエラーが発生したときに呼び出されます。
prepare:typesoptions@nuxt/cli が TypeScript 構成ファイル(.nuxt/tsconfig.app.json.nuxt/tsconfig.server.json など)および .nuxt/nuxt.d.ts を書き込む前に呼び出され、nuxt.d.ts にカスタム参照と宣言を追加したり、生成された構成のオプションを直接変更したりできます。
listenlistenerServer, listener開発サーバーがロードされているときに呼び出されます。
schema:extendschemasデフォルトスキーマの拡張を可能にします。
schema:resolvedschema解決済みスキーマの拡張を可能にします。
schema:beforeWriteschema指定されたスキーマの書き込み前に呼び出されます。
schema:written-スキーマが書き込まれた後に呼び出されます。
vite:extendviteBuildContextVite のデフォルトコンテキストの拡張を可能にします。
vite:extendConfigviteInlineConfig, envVite のデフォルト構成の拡張を可能にします。非推奨。 config フックを持つ Vite プラグインを追加することをお勧めします。
vite:configResolvedviteInlineConfig, env解決された Vite 構成の読み取りを可能にします。非推奨。 configResolved フックを持つ Vite プラグインを追加することをお勧めします。
vite:serverCreatedviteServer, envVite サーバーが作成されたときに呼び出されます。
vite:compiled-Vite サーバーがコンパイルされた後に呼び出されます。
webpack:configwebpackConfigswebpack コンパイラの構成前に呼び出されます。
webpack:configResolvedwebpackConfigs解決された webpack 構成の読み取りを可能にします。
webpack:compileoptionsコンパイル直前に呼び出されます。
webpack:compiledoptionsリソースがロードされた後に呼び出されます。
webpack:changeshortPathWebpackBar の change で呼び出されます。
webpack:error-WebpackBar にエラーがある場合、done で呼び出されます。
webpack:done-WebpackBar の allDone で呼び出されます。
webpack:progressstatesArrayWebpackBar の progress で呼び出されます。

Nitro アプリフック(ランタイム、サーバーサイド)

参照:Nitroをご確認ください。

フック引数説明タイプ
dev:ssr-logs{ path, logs }サーバーサーバーサイドログの配列とともにリクエストサイクルの最後に呼び出されます。
render:responseresponse, { event }レスポンスを送信する前に呼び出されます。response, event
render:htmlhtml, { event }HTML を構築する前に呼び出されます。html, event
render:islandislandResponse, { event, islandContext }アイランド HTML を構築する前に呼び出されます。islandResponse, event, islandContext
close-Nitro が閉じられたときに呼び出されます。-
errorerror, { event? }エラーが発生したときに呼び出されます。error, event
requesteventリクエストが受信されたときに呼び出されます。event
beforeResponseevent, { body }レスポンスを送信する前に呼び出されます。event, unknown
afterResponseevent, { body }レスポンスを送信した後に呼び出されます。event, unknown