docs: add description for vue:setup and app:data:refresh hooks (#31001)

This commit is contained in:
Alex Liu 2025-02-20 22:07:14 +08:00 committed by Daniel Roe
parent 11e6b8398c
commit ea71484fa3
No known key found for this signature in database
GPG Key ID: CBC814C393D93268

View File

@ -14,8 +14,7 @@ Hook | Arguments | Environment | Description
`app:created` | `vueApp` | Server & Client | Called when initial `vueApp` instance is created. `app:created` | `vueApp` | Server & Client | Called when initial `vueApp` instance is created.
`app:error` | `err` | Server & Client | Called when a fatal error occurs. `app:error` | `err` | Server & Client | Called when a fatal error occurs.
`app:error:cleared` | `{ redirect? }` | Server & Client | Called when a fatal error occurs. `app:error:cleared` | `{ redirect? }` | Server & Client | Called when a fatal error occurs.
`app:data:refresh` | `keys?` | Server & Client | (internal) `vue:setup` | - | Server & Client | Called when the setup of Nuxt root is initialized. This callback must be synchronous.
`vue:setup` | - | Server & Client | (internal)
`vue:error` | `err, target, info` | Server & Client | Called when a vue error propagates to the root component. [Learn More](https://vuejs.org/api/composition-api-lifecycle.html#onerrorcaptured). `vue:error` | `err, target, info` | Server & Client | Called when a vue error propagates to the root component. [Learn More](https://vuejs.org/api/composition-api-lifecycle.html#onerrorcaptured).
`app:rendered` | `renderContext` | Server | Called when SSR rendering is done. `app:rendered` | `renderContext` | Server | Called when SSR rendering is done.
`app:redirected` | - | Server | Called before SSR redirection. `app:redirected` | - | Server | Called before SSR redirection.
@ -23,6 +22,7 @@ Hook | Arguments | Environment | Description
`app:mounted` | `vueApp` | Client | Called when Vue app is initialized and mounted in browser. `app:mounted` | `vueApp` | Client | Called when Vue app is initialized and mounted in browser.
`app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event. `app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event.
`app:manifest:update` | `{ id, timestamp }` | Client | Called when there is a newer version of your app detected. `app:manifest:update` | `{ id, timestamp }` | Client | Called when there is a newer version of your app detected.
`app:data:refresh` | `keys?` | Client | Called when `refreshNuxtData` is called.
`link:prefetch` | `to` | Client | Called when a `<NuxtLink>` is observed to be prefetched. `link:prefetch` | `to` | Client | Called when a `<NuxtLink>` is observed to be prefetched.
`page:start` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event. `page:start` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event.
`page:finish` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event. `page:finish` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event.