生命周期钩子
Nuxt 提供了一个强大的钩子系统,可以使用钩子扩展几乎每个方面。
这个钩子系统由 unjs/hookable 提供支持。
Nuxt 钩子(构建时)
这些钩子可用于 Nuxt 模块和构建上下文。
在 nuxt.config
中
nuxt.config
export default defineNuxtConfig({
hooks: {
close: () => { }
}
})
在 Nuxt 模块中
import { defineNuxtModule } from '@nuxt/kit'
export default defineNuxtModule({
setup (options, nuxt) {
nuxt.hook('close', async () => { })
}
})
应用钩子(运行时)
应用钩子主要由 Nuxt 插件使用,以钩入渲染生命周期,但也可以在 Vue 组合式函数中使用。
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)
})
})
其他钩子
您可以通过扩充 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' {
interface NitroRuntimeHooks {
'your-nitro-hook': () => void;
}
}