v3.16
GitHub

生命周期钩子

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 组合式 API 中使用。

plugins/test.ts
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('page:start', () => {
    /* 你的代码在这里 */
  })
})
探索所有可用的应用钩子。

服务器钩子（运行时）

这些钩子可用于 服务器插件 来钩入 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>由自定义插件附加')
  })

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

附加钩子

您可以通过扩展 Nuxt 提供的类型来添加附加钩子。这对模块来说是非常有用的。

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