生命周期钩子
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 () => { })
}
})
App 钩子(运行时)
App 钩子主要可用于 Nuxt 插件 来钩入渲染生命周期,但也可以在 Vue 组合件中使用。
plugins/test.ts
export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.hook('page:start', () => {
/* your code goes here */
})
})
Server 钩子(运行时)
这些钩子可用于 server 插件 来钩入 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 'nitro/types' {
interface NitroRuntimeHooks {
'your-nitro-hook': () => void;
}
}