生命周期钩子

Nuxt 提供了一个强大的钩子系统，可以利用钩子扩展几乎所有方面。

Read more in Docs > Guide > Going Further > Hooks.

应用钩子（运行时）

查看应用源代码以获取所有可用钩子。

Hook	参数	环境	描述
`app:created`	`vueApp`	服务器和客户端	当初始的 `vueApp` 实例被创建时调用。
`app:error`	`err`	服务器和客户端	当发生致命错误时调用。
`app:error:cleared`	`{ redirect? }`	服务器和客户端	当致命错误被清除时调用。
`vue:setup`	-	服务器和客户端	当 Nuxt 根的 setup 被初始化时调用。此回调必须是同步的。
`vue:error`	`err, target, info`	服务器和客户端	当 Vue 错误传播到根组件时调用。了解更多。
`app:rendered`	`renderContext`	服务器	当 SSR 渲染完成时调用。
`app:redirected`	-	服务器	SSR 重定向之前调用。
`app:beforeMount`	`vueApp`	客户端	挂载应用之前调用，仅在客户端调用。
`app:mounted`	`vueApp`	客户端	当 Vue 应用初始化并挂载到浏览器时调用。
`app:suspense:resolve`	`appComponent`	客户端	在 Suspense 解析事件时调用。
`app:manifest:update`	`{ id, timestamp }`	客户端	当检测到应用有新版本时调用。
`app:data:refresh`	`keys?`	客户端	当调用 `refreshNuxtData` 时调用。
`link:prefetch`	`to`	客户端	当观察到 `<NuxtLink>` 被预取时调用。
`page:start`	`pageComponent?`	客户端	在 `NuxtPage` 内部的 Suspense 挂起事件时调用。
`page:finish`	`pageComponent?`	客户端	在 `NuxtPage` 内部的 Suspense 解析事件时调用。
`page:loading:start`	-	客户端	当新页面的 `setup()` 运行时调用。
`page:loading:end`	-	客户端	在 `page:finish` 之后调用。
`page:transition:finish`	`pageComponent?`	客户端	页面过渡后 onAfterLeave 事件后调用。
`dev:ssr-logs`	`logs`	客户端	当服务器端日志数组传递给客户端时调用（如果启用了 `features.devLogs`）。
`page:view-transition:start`	`transition`	客户端	当调用 `document.startViewTransition` 并且启用了实验性的 viewTransition 支持时调用。

Nuxt 钩子（构建时）

查看 schema 源代码以获取所有可用钩子。

Hook	参数	描述
`kit:compatibility`	`compatibility, issues`	允许扩展兼容性检查。
`ready`	`nuxt`	Nuxt 初始化完成后调用，表示 Nuxt 实例已准备好工作。
`close`	`nuxt`	当 Nuxt 实例优雅关闭时调用。
`restart`	`{ hard?: boolean }`	用于重启当前 Nuxt 实例。
`modules:before`	-	Nuxt 初始化期间，在安装用户模块之前调用。
`modules:done`	-	Nuxt 初始化期间，在安装用户模块之后调用。
`app:resolve`	`app`	解析 `app` 实例后调用。
`app:templates`	`app`	在生成 `NuxtApp` 期间调用，允许自定义、修改或添加构建目录的新文件（虚拟或写入 `.nuxt`）。
`app:templatesGenerated`	`app`	模板编译进虚拟文件系统（vfs）后调用。
`build:before`	-	Nuxt 打包构建之前调用。
`build:done`	-	Nuxt 打包构建完成后调用。
`build:manifest`	`manifest`	在 Vite 和 webpack 构建清单时调用。允许自定义 Nitro 用于生成最终 HTML 中 `<script>` 和 `<link>` 标签的清单。
`builder:generateApp`	`options`	生成应用之前调用。
`builder:watch`	`event, path`	开发时文件观察器检测到项目中文件或目录变化时调用。
`pages:extend`	`pages`	从文件系统扫描页面路由后调用。
`pages:resolved`	`pages`	页面路由携带扫描元数据增强后调用。
`pages:routerOptions`	`{ files: Array<{ path: string, optional?: boolean }> }`	解析 `router.options` 文件时调用。后面的数组项会覆盖前面的。
`server:devHandler`	`handler`	在 Nitro 开发服务器上注册开发中间件时调用。
`imports:sources`	`presets`	设置时允许模块扩展导入源。
`imports:extend`	`imports`	设置时允许模块扩展导入内容。
`imports:context`	`context`	创建 unimport 上下文时调用。
`imports:dirs`	`dirs`	允许扩展导入目录。
`components:dirs`	`dirs`	在 `app:resolve` 中调用，允许扩展扫描自动导入组件的目录。
`components:extend`	`components`	允许扩展新组件。
`nitro:config`	`nitroConfig`	初始化 Nitro 之前调用，允许自定义 Nitro 配置。
`nitro:init`	`nitro`	Nitro 初始化后调用，允许注册 Nitro 钩子并直接与 Nitro 交互。
`nitro:build:before`	`nitro`	构建 Nitro 实例之前调用。
`nitro:build:public-assets`	`nitro`	复制公共资源后调用，允许在 Nitro 服务器构建之前修改公共资源。
`prerender:routes`	`ctx`	允许扩展预渲染的路由。
`build:error`	`error`	构建时发生错误时调用。
`prepare:types`	`options`	在 `@nuxt/cli` 写入 `.nuxt/tsconfig.json` 和 `.nuxt/nuxt.d.ts` 之前调用，允许添加自定义引用和声明到 `nuxt.d.ts`，或直接修改 `tsconfig.json` 中的选项。
`listen`	`listenerServer, listener`	开发服务器启动时调用。
`schema:extend`	`schemas`	允许扩展默认 schema。
`schema:resolved`	`schema`	允许扩展已解析的 schema。
`schema:beforeWrite`	`schema`	写入给定 schema 之前调用。
`schema:written`	-	写入 schema 之后调用。
`vite:extend`	`viteBuildContext`	允许扩展 Vite 默认上下文。
`vite:extendConfig`	`viteInlineConfig, env`	允许扩展 Vite 默认配置。
`vite:configResolved`	`viteInlineConfig, env`	允许读取已解析的 Vite 配置。
`vite:serverCreated`	`viteServer, env`	Vite 服务器创建时调用。
`vite:compiled`	-	Vite 服务器编译完成后调用。
`webpack:config`	`webpackConfigs`	配置 webpack 编译器之前调用。
`webpack:configResolved`	`webpackConfigs`	允许读取已解析的 webpack 配置。
`webpack:compile`	`options`	编译前调用。
`webpack:compiled`	`options`	资源加载后调用。
`webpack:change`	`shortPath`	在 WebpackBar 的 `change` 事件时调用。
`webpack:error`	-	WebpackBar 的 `done` 且有错误时调用。
`webpack:done`	-	WebpackBar 的 `allDone` 事件时调用。
`webpack:progress`	`statesArray`	WebpackBar 的 `progress` 事件时调用。

Nitro 应用钩子（运行时，服务器端）

查看 Nitro 以获取所有可用钩子。

Hook	参数	描述	类型
`dev:ssr-logs`	`{ path, logs }`	服务器端	请求周期结束时，携带服务器端日志数组调用。
`render:response`	`response, { event }`	发送响应之前调用。	response, event
`render:html`	`html, { event }`	构建 HTML 之前调用。	html, event
`render:island`	`islandResponse, { event, islandContext }`	构建 island HTML 之前调用。	islandResponse, event, islandContext
`close`	-	Nitro 关闭时调用。	-
`error`	`error, { event? }`	发生错误时调用。	error, event
`request`	`event`	收到请求时调用。	event
`beforeResponse`	`event, { body }`	发送响应之前调用。	event, 未知
`afterResponse`	`event, { body }`	发送响应之后调用。	event, 未知

Was this helpful?

报告问题或者在 GitHub 上编辑此页面

插件

Nuxt Kit 提供了一组工具来帮助你创建和使用插件。你可以通过这些函数将插件或插件模板添加到你的模块中。

导入 meta

使用 `import.meta` 了解代码运行的位置。