生命周期钩子

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

在文档 > 4 X > 指南 > 进阶 > 钩子中阅读更多内容。

应用钩子 (运行时)

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

钩子	参数	环境	描述
`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`	`@BobbieGoede`	客户端	当检测到`<NuxtLink>`被预取时调用。
`page:start`	`pageComponent?`	客户端	在Suspense`NuxtPage`待处理事件中调用。
`page:finish`	`pageComponent?`	客户端	在Suspense`NuxtPage`已解析事件中调用。
`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 钩子 (构建时)

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

钩子	参数	描述
`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 构建 manifest 期间调用。这允许自定义 Nitro 将用于在最终 HTML 中渲染`<script>`和`<link>`标签的 manifest。
`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`写入 TypeScript 配置文件（`.nuxt/tsconfig.app.json`、`.nuxt/tsconfig.server.json`等）和`.nuxt/nuxt.d.ts`之前调用，允许在`nuxt.d.ts`中添加自定义引用和声明，或直接修改生成的配置中的选项。
`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 默认配置。已弃用。我们建议添加一个带有`config`钩子的 Vite 插件。
`vite:configResolved`	`viteInlineConfig, env`	允许读取已解析的 Vite 配置。已弃用。我们建议添加一个带有`configResolved`钩子的 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

这有帮助吗？

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

插件

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

Import meta

使用 `import.meta` 了解您的代码正在哪里运行。