生命周期钩子 · Nuxt API

在文档 > 指南 > 进一步了解 > 钩子中了解更多信息。

应用钩子 (运行时)

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

钩子	参数	环境	描述
`app:created`	`vueApp`	服务器 & 客户端	创建初始 `vueApp` 实例时调用。
`app:error`	`err`	服务器 & 客户端	发生致命错误时调用。
`app:error:cleared`	`{ redirect? }`	服务器 & 客户端	发生致命错误时调用。
`app:data:refresh`	`keys?`	服务器 & 客户端	(内部)
`vue: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 }`	客户端	检测到应用有更新版本时调用。
`link:prefetch`	`to`	客户端	当观察到 `<NuxtLink>` 被预取时调用。
`page:start`	`pageComponent?`	客户端	在 Suspense 等待事件上调用。
`page:finish`	`pageComponent?`	客户端	在 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 钩子 (构建时)

查看模式源代码以获取所有可用的钩子。

钩子	参数	描述
`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`	在 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

示例

使用 Nuxt Kit 工具的示例。

导入元数据

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