生命周期钩子

Nuxt 提供了一个强大的钩子系统，可以通过钩子扩展几乎每个方面。
钩子系统由 unjs/hookable 提供支持。

Nuxt 钩子（构建时）

这些钩子可供 Nuxt 模块 和构建上下文使用。

在 nuxt.config.ts 内

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 钩子。

应用钩子（运行时）

应用钩子主要可被 Nuxt 插件 用来挂入渲染生命周期，但也可在 Vue 组合式函数中使用。

app/plugins/test.ts
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('page:start', () => {
    /* your code goes here */
  })
})
查看所有可用的应用钩子。

服务器钩子（运行时）

这些钩子可供 服务器插件 用来挂入 Nitro 的运行时行为。

~/server/plugins/test.ts
export default defineNitroPlugin((nitroApp) => {
  nitroApp.hooks.hook('render:html', (html, { event }) => {
    console.log('render:html', html)
    html.bodyAppend.push('<hr>Appended by custom plugin')
  })

  nitroApp.hooks.hook('render:response', (response, { event }) => {
    console.log('render:response', response)
  })
})
了解更多可用的 Nitro 生命周期钩子。

添加自定义钩子

你可以通过扩展 Nuxt 的钩子接口来定义自定义钩子支持。

import type { 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
  }
}