生命周期钩子

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

阅读更多 Docs > Guide > Going Further > Hooks.

应用钩子（运行时）

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

钩子	参数	环境	描述
`app:created`	`vueApp`	服务端 & 客户端	在初始 `vueApp` 实例创建时调用。
`app:error`	`err`	服务端 & 客户端	发生致命错误时调用。
`app:error:cleared`	`{ redirect? }`	服务端 & 客户端	发生致命错误时调用。
`vue:setup`	-	服务端 & 客户端	在 Nuxt 根组件初始化设置时调用。此回调必须是同步的。
`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` 后触发。

Nuxt 钩子（构建时）

查看架构源代码获取所有可用钩子。

钩子	参数	描述
`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`	在模板编译到虚拟文件系统后调用。
`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`	在 Nuxi 写入 `.nuxt/tsconfig.json` 和 `.nuxt/nuxt.d.ts` 之前调用，允许在 `nuxt.d.ts` 中添加自定义引用和声明，或直接修改 `tsconfig.json` 的选项。
`listen`	`listenerServer, listener`	在开发服务器加载时调用。
`schema:extend`	`schemas`	允许扩展默认架构。
`schema:resolved`	`schema`	允许扩展已解析的架构。
`schema:beforeWrite`	`schema`	在写入给定架构之前调用。
`schema:written`	-	在架构写入后调用。
`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 获取所有可用钩子。

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

Report an issue or Edit this page on GitHub

插件

Nuxt Kit 提供了一组实用工具，帮助你创建和使用插件。你可以使用这些函数为你的模块添加插件或插件模板。

导入元数据

使用 `import.meta` 了解你的代码运行环境。