Lifecycle Hooks

Nuxt provides a powerful hooking system to expand almost every aspect using hooks.
The hooking system is powered by unjs/hookable.

Nuxt Hooks (Build Time)

These hooks are available for Nuxt modules and build context.

Within nuxt.config.ts

nuxt.config.ts
export default defineNuxtConfig({
  hooks: {
    close: () => { },
  },
})

Within Nuxt Modules

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options, nuxt) {
    nuxt.hook('close', async () => { })
  },
})
Explore all available Nuxt hooks.

App Hooks (Runtime)

App hooks can be mainly used by Nuxt Plugins to hook into rendering lifecycle but could also be used in Vue composables.

app/plugins/test.ts
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('page:start', () => {
    /* your code goes here */
  })
})
Explore all available App hooks.

Renderer Hooks (Runtime)

The Nuxt renderer calls these hooks while it renders a page, such as render:html to change the HTML before it is sent. A module registers them from a renderer plugin, which runs under any server builder.

import { addRendererPlugin, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    const { resolve } = createResolver(import.meta.url)
    addRendererPlugin(resolve('./runtime/server/renderer'))
  },
})

When Nuxt runs on Nitro, a server plugin can also register them on nitroApp.hooks.

Explore all available renderer hooks.

Server Hooks (Runtime)

These hooks are available for server plugins to hook into Nitro's runtime behavior, so they are only called when Nuxt runs on Nitro.

~~/server/plugins/test.ts
import { definePlugin } from 'nitro'

export default definePlugin((nitroApp) => {
  nitroApp.hooks.hook('request', (event) => {
    console.log('request', event.url.pathname)
  })

  nitroApp.hooks.hook('response', (response, event) => {
    console.log('response', response.status)
  })
})
Learn more about available Nitro lifecycle hooks.

Adding Custom Hooks

You can define your own custom hooks support by extending Nuxt's hook interfaces.

import type { HookResult } from '@nuxt/schema'

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

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