Nuxtフック（ビルド時）

これらのフックは、Nuxtモジュールおよびビルドコンテキストで利用可能です。

nuxt.config.ts 内で

export default defineNuxtConfig({
  hooks: {
    close: () => { }
  }
})

Nuxtモジュール内で

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options, nuxt) {
    nuxt.hook('close', async () => { })
  }
})

アプリフック（ランタイム）

アプリフックは主にNuxtプラグインによってレンダリングライフサイクルにフックするために使用されますが、Vueのコンポーザブルでも使用できます。

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('page:start', () => {
    /* ここにコードを記述 */
  })
})

サーバーフック（ランタイム）

これらのフックは、Nitroのランタイム動作にフックするためにサーバープラグインで利用可能です。

export default defineNitroPlugin((nitroApp) => {
  nitroApp.hooks.hook('render:html', (html, { event }) => {
    console.log('render:html', html)
    html.bodyAppend.push('<hr>カスタムプラグインによって追加されました')
  })

  nitroApp.hooks.hook('render:response', (response, { event }) => {
    console.log('render:response', response)
  })
})

カスタムフックの追加

Nuxtのフックインターフェースを拡張することで、独自のカスタムフックサポートを定義できます。

import { HookResult } from "@nuxt/schema";

declare module '#app' {
  interface RuntimeNuxtHooks {
    'your-nuxt-runtime-hook': () => HookResult
  }
  interface NuxtHooks {
    'your-nuxt-hook': () => HookResult
  }
}

declare module 'nitropack/types' {
  interface NitroRuntimeHooks {
    'your-nitro-hook': () => void;
  }
}