查看应用源代码以了解所有可用的钩子。
| 钩子 | 参数 | 环境 | 描述 |
|---|---|---|---|
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 | @BobbieGoede | 客户端 | 在观察到 <NuxtLink> 需要预取时调用。 |
page:start | pageComponent? | 客户端 | 在SuspenseNuxtPage 挂起事件内部调用。 |
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 | 客户端 | 当 启用了实验性的 viewTransition 支持 且调用了 document.startViewTransition 之后调用。 |
查看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 bundle 构建器之前调用。 |
build:done | - | 在 Nuxt bundle 构建器完成后调用。 |
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 dev 服务器时调用。 |
imports:sources | presets | 在设置时调用，允许模块扩展源。 |
imports:extend | imports (导入) | 在设置时调用，允许模块扩展导入。 |
imports:context | context | 在unimport创建 context 时调用。 |
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 默认 context。 |
vite:extendConfig | viteInlineConfig, env | 允许扩展 Vite 默认配置。**在 Nuxt 5+ 中已弃用。** 在 Nuxt 5 中，此操作作用于共享配置而不是单独的客户端/服务器配置。 |
vite:configResolved | viteInlineConfig, env | 允许读取已解析的 Vite 配置。**在 Nuxt 5+ 中已弃用。** 在 Nuxt 5 中，此操作作用于共享配置而不是单独的客户端/服务器配置。 |
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以了解所有可用的钩子。
| 钩子 | 参数 | 描述 | 类型 |
|---|---|---|---|
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 |