@nuxt/docs 3.19.2 → 3.20.0

package/1.getting-started/10.data-fetching.md

@@ -4,23 +4,23 @@ description: Nuxt provides composables to handle data fetching within your appli
 navigation.icon: i-lucide-cable
 ---
 
-Nuxt comes with two composables and a built-in library to perform data-fetching in browser or server environments: `useFetch`, [`useAsyncData`](/docs/api/composables/use-async-data) and `$fetch`.
+Nuxt comes with two composables and a built-in library to perform data-fetching in browser or server environments: `useFetch`, [`useAsyncData`](/docs/3.x/api/composables/use-async-data) and `$fetch`.
 
 In a nutshell:
 
-- [`$fetch`](/docs/api/utils/dollarfetch) is the simplest way to make a network request.
-- [`useFetch`](/docs/api/composables/use-fetch) is a wrapper around `$fetch` that fetches data only once in [universal rendering](/docs/guide/concepts/rendering#universal-rendering).
-- [`useAsyncData`](/docs/api/composables/use-async-data) is similar to `useFetch` but offers more fine-grained control.
+- [`$fetch`](/docs/3.x/api/utils/dollarfetch) is the simplest way to make a network request.
+- [`useFetch`](/docs/3.x/api/composables/use-fetch) is a wrapper around `$fetch` that fetches data only once in [universal rendering](/docs/3.x/guide/concepts/rendering#universal-rendering).
+- [`useAsyncData`](/docs/3.x/api/composables/use-async-data) is similar to `useFetch` but offers more fine-grained control.
 
 Both `useFetch` and `useAsyncData` share a common set of options and patterns that we will detail in the last sections.
 
 ## The need for `useFetch` and `useAsyncData`
 
-Nuxt is a framework which can run isomorphic (or universal) code in both server and client environments. If the [`$fetch` function](/docs/api/utils/dollarfetch) is used to perform data fetching in the setup function of a Vue component, this may cause data to be fetched twice, once on the server (to render the HTML) and once again on the client (when the HTML is hydrated). This can cause hydration issues, increase the time to interactivity and cause unpredictable behavior.
+Nuxt is a framework which can run isomorphic (or universal) code in both server and client environments. If the [`$fetch` function](/docs/3.x/api/utils/dollarfetch) is used to perform data fetching in the setup function of a Vue component, this may cause data to be fetched twice, once on the server (to render the HTML) and once again on the client (when the HTML is hydrated). This can cause hydration issues, increase the time to interactivity and cause unpredictable behavior.
 
-The [`useFetch`](/docs/api/composables/use-fetch) and [`useAsyncData`](/docs/api/composables/use-async-data) composables solve this problem by ensuring that if an API call is made on the server, the data is forwarded to the client in the payload.
+The [`useFetch`](/docs/3.x/api/composables/use-fetch) and [`useAsyncData`](/docs/3.x/api/composables/use-async-data) composables solve this problem by ensuring that if an API call is made on the server, the data is forwarded to the client in the payload.
 
-The payload is a JavaScript object accessible through [`useNuxtApp().payload`](/docs/api/composables/use-nuxt-app#payload). It is used on the client to avoid refetching the same data when the code is executed in the browser [during hydration](/docs/guide/concepts/rendering#universal-rendering).
+The payload is a JavaScript object accessible through [`useNuxtApp().payload`](/docs/3.x/api/composables/use-nuxt-app#payload). It is used on the client to avoid refetching the same data when the code is executed in the browser [during hydration](/docs/3.x/guide/concepts/rendering#universal-rendering).
 
 ::tip
 Use the [Nuxt DevTools](https://devtools.nuxt.com) to inspect this data in the **Payload tab**.
@@ -30,12 +30,12 @@ Use the [Nuxt DevTools](https://devtools.nuxt.com) to inspect this data in the *
 <script setup lang="ts">
 const { data } = await useFetch('/api/data')
 
-async function handleFormSubmit() {
+async function handleFormSubmit () {
   const res = await $fetch('/api/submit', {
     method: 'POST',
     body: {
       // My form data
-    }
+    },
   })
 }
 </script>
@@ -59,7 +59,7 @@ In the example above, `useFetch` would make sure that the request would occur in
 Nuxt uses Vue's [`<Suspense>`](https://vuejs.org/guide/built-ins/suspense) component under the hood to prevent navigation before every async data is available to the view. The data fetching composables can help you leverage this feature and use what suits best on a per-call basis.
 
 ::note
-You can add the [`<NuxtLoadingIndicator>`](/docs/api/components/nuxt-loading-indicator) to add a progress bar between page navigations.
+You can add the [`<NuxtLoadingIndicator>`](/docs/3.x/api/components/nuxt-loading-indicator) to add a progress bar between page navigations.
 ::
 
 ## `$fetch`
@@ -68,12 +68,12 @@ Nuxt includes the [ofetch](https://github.com/unjs/ofetch) library, and is auto-
 
 ```vue twoslash [pages/todos.vue]
 <script setup lang="ts">
-async function addTodo() {
+async function addTodo () {
   const todo = await $fetch('/api/todos', {
     method: 'POST',
     body: {
       // My todo data
-    }
+    },
   })
 }
 </script>
@@ -90,11 +90,11 @@ Read more about `$fetch`.
 
 ### Pass Client Headers to the API
 
-When calling `useFetch` on the server, Nuxt will use [`useRequestFetch`](/docs/api/composables/use-request-fetch) to proxy client headers and cookies (with the exception of headers not meant to be forwarded, like `host`).
+When calling `useFetch` on the server, Nuxt will use [`useRequestFetch`](/docs/3.x/api/composables/use-request-fetch) to proxy client headers and cookies (with the exception of headers not meant to be forwarded, like `host`).
 
 ```vue
 <script setup lang="ts">
-const { data } = await useFetch('/api/echo');
+const { data } = await useFetch('/api/echo')
 </script>
 ```
 
@@ -103,20 +103,20 @@ const { data } = await useFetch('/api/echo');
 export default defineEventHandler(event => parseCookies(event))
 ```
 
-Alternatively, the example below shows how to use [`useRequestHeaders`](/docs/api/composables/use-request-headers) to access and send cookies to the API from a server-side request (originating on the client). Using an isomorphic `$fetch` call, we ensure that the API endpoint has access to the same `cookie` header originally sent by the user's browser. This is only necessary if you aren't using `useFetch`.
+Alternatively, the example below shows how to use [`useRequestHeaders`](/docs/3.x/api/composables/use-request-headers) to access and send cookies to the API from a server-side request (originating on the client). Using an isomorphic `$fetch` call, we ensure that the API endpoint has access to the same `cookie` header originally sent by the user's browser. This is only necessary if you aren't using `useFetch`.
 
 ```vue
 <script setup lang="ts">
 const headers = useRequestHeaders(['cookie'])
 
-async function getCurrentUser() {
+async function getCurrentUser () {
   return await $fetch('/api/me', { headers })
 }
 </script>
 ```
 
 ::tip
-You can also use [`useRequestFetch`](/docs/api/composables/use-request-fetch) to proxy headers to the call automatically.
+You can also use [`useRequestFetch`](/docs/3.x/api/composables/use-request-fetch) to proxy headers to the call automatically.
 ::
 
 ::caution
@@ -130,7 +130,7 @@ Be very careful before proxying headers to an external API and just include head
 
 ## `useFetch`
 
-The [`useFetch`](/docs/api/composables/use-fetch) composable uses `$fetch` under-the-hood to make SSR-safe network calls in the setup function.
+The [`useFetch`](/docs/3.x/api/composables/use-fetch) composable uses `$fetch` under-the-hood to make SSR-safe network calls in the setup function.
 
 ```vue twoslash [app.vue]
 <script setup lang="ts">
@@ -142,7 +142,7 @@ const { data: count } = await useFetch('/api/count')
 </template>
 ```
 
-This composable is a wrapper around the [`useAsyncData`](/docs/api/composables/use-async-data) composable and `$fetch` utility.
+This composable is a wrapper around the [`useAsyncData`](/docs/3.x/api/composables/use-async-data) composable and `$fetch` utility.
 
 :video-accordion{title="Watch a video from Alexander Lichter to avoid using useFetch the wrong way" videoId="njsGVmcWviY"}
 
@@ -156,12 +156,12 @@ The `useAsyncData` composable is responsible for wrapping async logic and return
 
 ::tip
 `useFetch(url)` is nearly equivalent to `useAsyncData(url, () => event.$fetch(url))`. :br
-It's developer experience sugar for the most common use case. (You can find out more about `event.fetch` at [`useRequestFetch`](/docs/api/composables/use-request-fetch).)
+It's developer experience sugar for the most common use case. (You can find out more about `event.fetch` at [`useRequestFetch`](/docs/3.x/api/composables/use-request-fetch).)
 ::
 
 :video-accordion{title="Watch a video from Alexander Lichter to dig deeper into the difference between useFetch and useAsyncData" videoId="0X-aOpSGabA"}
 
-There are some cases when using the [`useFetch`](/docs/api/composables/use-fetch) composable is not appropriate, for example when a CMS or a third-party provide their own query layer. In this case, you can use [`useAsyncData`](/docs/api/composables/use-async-data) to wrap your calls and still keep the benefits provided by the composable.
+There are some cases when using the [`useFetch`](/docs/3.x/api/composables/use-fetch) composable is not appropriate, for example when a CMS or a third-party provide their own query layer. In this case, you can use [`useAsyncData`](/docs/3.x/api/composables/use-async-data) to wrap your calls and still keep the benefits provided by the composable.
 
 ```vue [pages/users.vue]
 <script setup lang="ts">
@@ -173,11 +173,11 @@ const { data, error } = await useAsyncData(() => myGetFunction('users'))
 ```
 
 ::note
-The first argument of [`useAsyncData`](/docs/api/composables/use-async-data) is a unique key used to cache the response of the second argument, the querying function. This key can be ignored by directly passing the querying function, the key will be auto-generated.
+The first argument of [`useAsyncData`](/docs/3.x/api/composables/use-async-data) is a unique key used to cache the response of the second argument, the querying function. This key can be ignored by directly passing the querying function, the key will be auto-generated.
 :br :br
 Since the autogenerated key only takes into account the file and line where `useAsyncData` is invoked, it is recommended to always create your own key to avoid unwanted behavior, like when you are creating your own custom composable wrapping `useAsyncData`.
 :br :br
-Setting a key can be useful to share the same data between components using [`useNuxtData`](/docs/api/composables/use-nuxt-data) or to [refresh specific data](/docs/api/utils/refresh-nuxt-data#refresh-specific-data).
+Setting a key can be useful to share the same data between components using [`useNuxtData`](/docs/3.x/api/composables/use-nuxt-data) or to [refresh specific data](/docs/3.x/api/utils/refresh-nuxt-data#refresh-specific-data).
 ::
 
 ```vue [pages/users/[id\\].vue]
@@ -197,7 +197,7 @@ The `useAsyncData` composable is a great way to wrap and wait for multiple `$fet
 const { data: discounts, status } = await useAsyncData('cart-discount', async () => {
   const [coupons, offers] = await Promise.all([
     $fetch('/cart/coupons'),
-    $fetch('/cart/offers')
+    $fetch('/cart/offers'),
   ])
 
   return { coupons, offers }
@@ -208,7 +208,7 @@ const { data: discounts, status } = await useAsyncData('cart-discount', async ()
 ```
 
 ::note
-`useAsyncData` is for fetching and caching data, not triggering side effects like calling Pinia actions, as this can cause unintended behavior such as repeated executions with nullish values. If you need to trigger side effects, use the [`callOnce`](/docs/api/utils/call-once) utility to do so.
+`useAsyncData` is for fetching and caching data, not triggering side effects like calling Pinia actions, as this can cause unintended behavior such as repeated executions with nullish values. If you need to trigger side effects, use the [`callOnce`](/docs/3.x/api/utils/call-once) utility to do so.
 
 ```vue
 <script setup lang="ts">
@@ -246,7 +246,7 @@ If you have not fetched data on the server (for example, with `server: false`),
 
 ## Options
 
-[`useAsyncData`](/docs/api/composables/use-async-data) and [`useFetch`](/docs/api/composables/use-fetch) return the same object type and accept a common set of options as their last argument. They can help you control the composables behavior, such as navigation blocking, caching or execution.
+[`useAsyncData`](/docs/3.x/api/composables/use-async-data) and [`useFetch`](/docs/3.x/api/composables/use-fetch) return the same object type and accept a common set of options as their last argument. They can help you control the composables behavior, such as navigation blocking, caching or execution.
 
 ### Lazy
 
@@ -255,7 +255,7 @@ By default, data fetching composables will wait for the resolution of their asyn
 ```vue twoslash [app.vue]
 <script setup lang="ts">
 const { status, data: posts } = useFetch('/api/posts', {
-  lazy: true
+  lazy: true,
 })
 </script>
 
@@ -272,7 +272,7 @@ const { status, data: posts } = useFetch('/api/posts', {
 </template>
 ```
 
-You can alternatively use [`useLazyFetch`](/docs/api/composables/use-lazy-fetch) and `useLazyAsyncData` as convenient methods to perform the same.
+You can alternatively use [`useLazyFetch`](/docs/3.x/api/composables/use-lazy-fetch) and `useLazyAsyncData` as convenient methods to perform the same.
 
 ```vue twoslash
 <script setup lang="ts">
@@ -303,7 +303,7 @@ const articles = await useFetch('/api/article')
 /* This call will only be performed on the client */
 const { status, data: comments } = useFetch('/api/comments', {
   lazy: true,
-  server: false
+  server: false,
 })
 ```
 
@@ -317,7 +317,7 @@ The `pick` option helps you to minimize the payload size stored in your HTML doc
 <script setup lang="ts">
 /* only pick the fields used in your template */
 const { data: mountain } = await useFetch('/api/mountains/everest', {
-  pick: ['title', 'description']
+  pick: ['title', 'description'],
 })
 </script>
 
@@ -333,7 +333,7 @@ If you need more control or map over several objects, you can use the `transform
 const { data: mountains } = await useFetch('/api/mountains', {
   transform: (mountains) => {
     return mountains.map(mountain => ({ title: mountain.title, description: mountain.description }))
-  }
+  },
 })
 ```
 
@@ -347,13 +347,13 @@ Both `pick` and `transform` don't prevent the unwanted data from being fetched i
 
 #### Keys
 
-[`useFetch`](/docs/api/composables/use-fetch) and [`useAsyncData`](/docs/api/composables/use-async-data) use keys to prevent refetching the same data.
+[`useFetch`](/docs/3.x/api/composables/use-fetch) and [`useAsyncData`](/docs/3.x/api/composables/use-async-data) use keys to prevent refetching the same data.
 
-- [`useFetch`](/docs/api/composables/use-fetch) uses the provided URL as a key. Alternatively, a `key` value can be provided in the `options` object passed as a last argument.
-- [`useAsyncData`](/docs/api/composables/use-async-data) uses its first argument as a key if it is a string. If the first argument is the handler function that performs the query, then a key that is unique to the file name and line number of the instance of `useAsyncData` will be generated for you.
+- [`useFetch`](/docs/3.x/api/composables/use-fetch) uses the provided URL as a key. Alternatively, a `key` value can be provided in the `options` object passed as a last argument.
+- [`useAsyncData`](/docs/3.x/api/composables/use-async-data) uses its first argument as a key if it is a string. If the first argument is the handler function that performs the query, then a key that is unique to the file name and line number of the instance of `useAsyncData` will be generated for you.
 
 ::tip
-To get the cached data by key, you can use [`useNuxtData`](/docs/api/composables/use-nuxt-data)
+To get the cached data by key, you can use [`useNuxtData`](/docs/3.x/api/composables/use-nuxt-data)
 ::
 
 :video-accordion{title="Watch a video from Vue School on caching data with the key option" videoId="1026410044" platform="vimeo"}
@@ -406,7 +406,7 @@ You can use computed refs, plain refs or getter functions as keys, allowing for
 const userId = ref('123')
 const { data: user } = useAsyncData(
   computed(() => `user-${userId.value}`),
-  () => fetchUser(userId.value)
+  () => fetchUser(userId.value),
 )
 
 // When userId changes, the data will be automatically refetched
@@ -426,7 +426,9 @@ const { data, error, execute, refresh } = await useFetch('/api/users')
 <template>
   <div>
     <p>{{ data }}</p>
-    <button @click="() => refresh()">Refresh data</button>
+    <button @click="() => refresh()">
+      Refresh data
+    </button>
   </div>
 </template>
 ```
@@ -434,7 +436,7 @@ const { data, error, execute, refresh } = await useFetch('/api/users')
 The `execute` function is an alias for `refresh` that works in exactly the same way but is more semantic for cases when the fetch is [not immediate](#not-immediate).
 
 ::tip
-To globally refetch or invalidate cached data, see [`clearNuxtData`](/docs/api/utils/clear-nuxt-data) and [`refreshNuxtData`](/docs/api/utils/refresh-nuxt-data).
+To globally refetch or invalidate cached data, see [`clearNuxtData`](/docs/3.x/api/utils/clear-nuxt-data) and [`refreshNuxtData`](/docs/3.x/api/utils/refresh-nuxt-data).
 ::
 
 #### Clear
@@ -447,7 +449,9 @@ const { data, clear } = await useFetch('/api/users')
 
 const route = useRoute()
 watch(() => route.path, (path) => {
-  if (path === '/') clear()
+  if (path === '/') {
+    clear()
+  }
 })
 </script>
 ```
@@ -462,7 +466,7 @@ const id = ref(1)
 
 const { data, error, refresh } = await useFetch('/api/users', {
   /* Changing the id will trigger a refetch */
-  watch: [id]
+  watch: [id],
 })
 </script>
 ```
@@ -474,13 +478,28 @@ Note that **watching a reactive value won't change the URL fetched**. For exampl
 const id = ref(1)
 
 const { data, error, refresh } = await useFetch(`/api/users/${id.value}`, {
-  watch: [id]
+  watch: [id],
 })
 </script>
 ```
 
 If you need to change the URL based on a reactive value, you may want to use a [computed URL](#computed-url) instead.
 
+When reactive fetch options are provided, they'll be automatically watched and trigger refetches. In some cases, it can be useful to opt-out of this behavior by specifying `watch: false`.
+
+```ts
+const id = ref(1)
+
+// Won't automatically refetch when id changes
+const { data, execute } = await useFetch('/api/users', {
+  query: { id }, // id is watched by default
+  watch: false, // disables automatic watching of id
+})
+
+// doesn't trigger refetch
+id.value = 2
+```
+
 #### Computed URL
 
 Sometimes you may need to compute a URL from reactive values, and refresh the data each time these change. Instead of juggling your way around, you can attach each param as a reactive value. Nuxt will automatically use the reactive value and re-fetch each time it changes.
@@ -491,8 +510,8 @@ const id = ref(null)
 
 const { data, status } = useLazyFetch('/api/user', {
   query: {
-    user_id: id
-  }
+    user_id: id,
+  },
 })
 </script>
 ```
@@ -506,16 +525,20 @@ Every time a dependency changes, the data will be fetched using the newly constr
 const id = ref(null)
 
 const { data, status } = useLazyFetch(() => `/api/users/${id.value}`, {
-  immediate: false
+  immediate: false,
 })
 
-const pending = computed(() => status.value === 'pending');
+const pending = computed(() => status.value === 'pending')
 </script>
 
 <template>
   <div>
     <!-- disable the input while fetching -->
-    <input v-model="id" type="number" :disabled="pending"/>
+    <input
+      v-model="id"
+      type="number"
+      :disabled="pending"
+    >
 
     <div v-if="status === 'idle'">
       Type an user ID
@@ -543,13 +566,15 @@ With that, you will need both the `status` to handle the fetch lifecycle, and `e
 ```vue
 <script setup lang="ts">
 const { data, error, execute, status } = await useLazyFetch('/api/comments', {
-  immediate: false
+  immediate: false,
 })
 </script>
 
 <template>
   <div v-if="status === 'idle'">
-    <button @click="execute">Get data</button>
+    <button @click="execute">
+      Get data
+    </button>
   </div>
 
   <div v-else-if="status === 'pending'">
@@ -575,7 +600,7 @@ When we call `$fetch` in the browser, user headers like `cookie` will be directl
 
 Normally, during server-side-rendering, due to security considerations, the `$fetch` wouldn't include the user's browser cookies, nor pass on cookies from the fetch response.
 
-However, when calling `useFetch` with a relative URL on the server, Nuxt will use [`useRequestFetch`](/docs/api/composables/use-request-fetch) to proxy headers and cookies (with the exception of headers not meant to be forwarded, like `host`).
+However, when calling `useFetch` with a relative URL on the server, Nuxt will use [`useRequestFetch`](/docs/3.x/api/composables/use-request-fetch) to proxy headers and cookies (with the exception of headers not meant to be forwarded, like `host`).
 
 ### Pass Cookies From Server-side API Calls on SSR Response
 
@@ -621,9 +646,9 @@ export default defineNuxtComponent({
   fetchKey: 'hello',
   async asyncData () {
     return {
-      hello: await $fetch('/api/hello')
+      hello: await $fetch('/api/hello'),
     }
-  }
+  },
 })
 </script>
 ```
@@ -636,9 +661,9 @@ Using `<script setup>` or `<script setup lang="ts">` are the recommended way of
 
 ## Serializing Data From Server to Client
 
-When using `useAsyncData` and `useLazyAsyncData` to transfer data fetched on server to the client (as well as anything else that utilizes [the Nuxt payload](/docs/api/composables/use-nuxt-app#payload)), the payload is serialized with [`devalue`](https://github.com/Rich-Harris/devalue). This allows us to transfer not just basic JSON but also to serialize and revive/deserialize more advanced kinds of data, such as regular expressions, Dates, Map and Set, `ref`, `reactive`, `shallowRef`, `shallowReactive` and `NuxtError` - and more.
+When using `useAsyncData` and `useLazyAsyncData` to transfer data fetched on server to the client (as well as anything else that utilizes [the Nuxt payload](/docs/3.x/api/composables/use-nuxt-app#payload)), the payload is serialized with [`devalue`](https://github.com/Rich-Harris/devalue). This allows us to transfer not just basic JSON but also to serialize and revive/deserialize more advanced kinds of data, such as regular expressions, Dates, Map and Set, `ref`, `reactive`, `shallowRef`, `shallowReactive` and `NuxtError` - and more.
 
-It is also possible to define your own serializer/deserializer for types that are not supported by Nuxt. You can read more in the [`useNuxtApp`](/docs/api/composables/use-nuxt-app#payload) docs.
+It is also possible to define your own serializer/deserializer for types that are not supported by Nuxt. You can read more in the [`useNuxtApp`](/docs/3.x/api/composables/use-nuxt-app#payload) docs.
 
 ::note
 Note that this _does not apply_ to data passed from your server routes when fetched with `$fetch` or `useFetch` - see the next section for more information.
@@ -646,7 +671,7 @@ Note that this _does not apply_ to data passed from your server routes when fetc
 
 ## Serializing Data From API Routes
 
-When fetching data from the `server` directory, the response is serialized using `JSON.stringify`. However, since serialization is limited to only JavaScript primitive types, Nuxt does its best to convert the return type of `$fetch` and [`useFetch`](/docs/api/composables/use-fetch) to match the actual value.
+When fetching data from the `server` directory, the response is serialized using `JSON.stringify`. However, since serialization is limited to only JavaScript primitive types, Nuxt does its best to convert the return type of `$fetch` and [`useFetch`](/docs/3.x/api/composables/use-fetch) to match the actual value.
 
 ::read-more{icon="i-simple-icons-mdnwebdocs" to="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description" target="_blank"}
 Learn more about `JSON.stringify` limitations.
@@ -676,7 +701,7 @@ export default defineEventHandler(() => {
   const data = {
     createdAt: new Date(),
 
-    toJSON() {
+    toJSON () {
       return {
         createdAt: {
           year: this.createdAt.getFullYear(),
@@ -688,7 +713,6 @@ export default defineEventHandler(() => {
   }
   return data
 })
-
 ```
 
 ```vue [app.vue]
@@ -719,9 +743,9 @@ export default defineEventHandler(() => {
     createdAt: new Date(),
 
     // Workaround the type conversion
-    toJSON() {
+    toJSON () {
       return this
-    }
+    },
   }
 
   // Serialize the output to string, using superjson
@@ -757,7 +781,7 @@ When consuming SSE via POST request, you need to handle the connection manually.
 const response = await $fetch<ReadableStream>('/chats/ask-ai', {
   method: 'POST',
   body: {
-    query: "Hello AI, how are you?",
+    query: 'Hello AI, how are you?',
   },
   responseType: 'stream',
 })
@@ -769,8 +793,7 @@ const reader = response.pipeThrough(new TextDecoderStream()).getReader()
 while (true) {
   const { value, done } = await reader.read()
 
-  if (done)
-    break
+  if (done) { break }
 
   console.log('Received:', value)
 }
@@ -783,13 +806,13 @@ When requests don't rely on each other, you can make them in parallel with `Prom
 ```ts
 const { data } = await useAsyncData(() => {
   return Promise.all([
-    $fetch("/api/comments/"), 
-    $fetch("/api/author/12")
-  ]);
-});
+    $fetch('/api/comments/'),
+    $fetch('/api/author/12'),
+  ])
+})
 
-const comments = computed(() => data.value?.[0]);
-const author = computed(() => data.value?.[1]);
+const comments = computed(() => data.value?.[0])
+const author = computed(() => data.value?.[1])
 ```
 
 :video-accordion{title="Watch a video from Vue School on parallel data fetching" videoId="1024262536" platform="vimeo"}

package/1.getting-started/11.state-management.md

@@ -4,14 +4,14 @@ description: Nuxt provides powerful state management libraries and the useState
 navigation.icon: i-lucide-database
 ---
 
-Nuxt provides the [`useState`](/docs/api/composables/use-state) composable to create a reactive and SSR-friendly shared state across components.
+Nuxt provides the [`useState`](/docs/3.x/api/composables/use-state) composable to create a reactive and SSR-friendly shared state across components.
 
-[`useState`](/docs/api/composables/use-state) is an SSR-friendly [`ref`](https://vuejs.org/api/reactivity-core.html#ref) replacement. Its value will be preserved after server-side rendering (during client-side hydration) and shared across all components using a unique key.
+[`useState`](/docs/3.x/api/composables/use-state) is an SSR-friendly [`ref`](https://vuejs.org/api/reactivity-core.html#ref) replacement. Its value will be preserved after server-side rendering (during client-side hydration) and shared across all components using a unique key.
 
 :video-accordion{title="Watch a video from Alexander Lichter about why and when to use useState" videoId="mv0WcBABcIk"}
 
 ::important
-Because the data inside [`useState`](/docs/api/composables/use-state) will be serialized to JSON, it is important that it does not contain anything that cannot be serialized, such as classes, functions or symbols.
+Because the data inside [`useState`](/docs/3.x/api/composables/use-state) will be serialized to JSON, it is important that it does not contain anything that cannot be serialized, such as classes, functions or symbols.
 ::
 
 ::read-more{to="/docs/api/composables/use-state"}
@@ -56,12 +56,12 @@ const counter = useState('counter', () => Math.round(Math.random() * 1000))
 :link-example{to="/docs/examples/features/state-management"}
 
 ::note
-To globally invalidate cached state, see [`clearNuxtState`](/docs/api/utils/clear-nuxt-state) util.
+To globally invalidate cached state, see [`clearNuxtState`](/docs/3.x/api/utils/clear-nuxt-state) util.
 ::
 
 ### Initializing State
 
-Most of the time, you will want to initialize your state with data that resolves asynchronously. You can use the [`app.vue`](/docs/guide/directory-structure/app) component with the [`callOnce`](/docs/api/utils/call-once) util to do so.
+Most of the time, you will want to initialize your state with data that resolves asynchronously. You can use the [`app.vue`](/docs/3.x/guide/directory-structure/app) component with the [`callOnce`](/docs/3.x/api/utils/call-once) util to do so.
 
 ```vue twoslash [app.vue]
 <script setup lang="ts">
@@ -92,16 +92,16 @@ Make sure to install the Pinia module with `npx nuxt module add pinia` or follow
 export const useWebsiteStore = defineStore('websiteStore', {
   state: () => ({
     name: '',
-    description: ''
+    description: '',
   }),
   actions: {
-    async fetch() {
+    async fetch () {
       const infos = await $fetch('https://api.nuxt.com/modules/pinia')
 
       this.name = infos.name
       this.description = infos.description
-    }
-  }
+    },
+  },
 })
 ```
 ```vue [app.vue]
@@ -151,8 +151,8 @@ export const useLocales = () => {
   const locales = ref([
     'en-US',
     'en-GB',
-    ...
-    'ja-JP-u-ca-japanese'
+    // ...,
+    'ja-JP-u-ca-japanese',
   ])
   if (!locales.value.includes(locale.value)) {
     locales.value.unshift(locale.value)
@@ -177,8 +177,15 @@ const date = useLocaleDate(new Date('2016-10-26'))
     <h1>Nuxt birthday</h1>
     <p>{{ date }}</p>
     <label for="locale-chooser">Preview a different locale</label>
-    <select id="locale-chooser" v-model="locale">
-      <option v-for="loc of locales" :key="loc" :value="loc">
+    <select
+      id="locale-chooser"
+      v-model="locale"
+    >
+      <option
+        v-for="loc of locales"
+        :key="loc"
+        :value="loc"
+      >
         {{ loc }}
       </option>
     </select>
@@ -191,7 +198,7 @@ const date = useLocaleDate(new Date('2016-10-26'))
 
 ## Shared State
 
-By using [auto-imported composables](/docs/guide/directory-structure/composables) we can define global type-safe states and import them across the app.
+By using [auto-imported composables](/docs/3.x/guide/directory-structure/composables) we can define global type-safe states and import them across the app.
 
 ```ts twoslash [composables/states.ts]
 export const useColor = () => useState<string>('color', () => 'pink')
@@ -214,7 +221,7 @@ const color = useColor() // Same as useState('color')
 
 ## Using third-party libraries
 
-Nuxt **used to rely** on the Vuex library to provide global state management. If you are migrating from Nuxt 2, please head to [the migration guide](/docs/migration/configuration#vuex).
+Nuxt **used to rely** on the Vuex library to provide global state management. If you are migrating from Nuxt 2, please head to [the migration guide](/docs/3.x/migration/configuration#vuex).
 
 Nuxt is not opinionated about state management, so feel free to choose the right solution for your needs. There are multiple integrations with the most popular state management libraries, including:
 

package/1.getting-started/12.error-handling.md

@@ -8,7 +8,7 @@ Nuxt is a full-stack framework, which means there are several sources of unpreve
 
 - Errors during the Vue rendering lifecycle (SSR & CSR)
 - Server and client startup errors (SSR + CSR)
-- Errors during Nitro server lifecycle ([`server/`](/docs/guide/directory-structure/server) directory)
+- Errors during Nitro server lifecycle ([`server/`](/docs/3.x/guide/directory-structure/server) directory)
 - Errors downloading JS chunks
 
 ::tip
@@ -19,7 +19,7 @@ Nuxt is a full-stack framework, which means there are several sources of unpreve
 
 You can hook into Vue errors using [`onErrorCaptured`](https://vuejs.org/api/composition-api-lifecycle.html#onerrorcaptured).
 
-In addition, Nuxt provides a [`vue:error`](/docs/api/advanced/hooks#app-hooks-runtime) hook that will be called if any errors propagate up to the top level.
+In addition, Nuxt provides a [`vue:error`](/docs/3.x/api/advanced/hooks#app-hooks-runtime) hook that will be called if any errors propagate up to the top level.
 
 If you are using an error reporting framework, you can provide a global handler through [`vueApp.config.errorHandler`](https://vuejs.org/api/application.html#app-config-errorhandler). It will receive all Vue errors, even if they are handled.
 
@@ -45,7 +45,7 @@ Note that the `vue:error` hook is based on [`onErrorCaptured`](https://vuejs.org
 Nuxt will call the `app:error` hook if there are any errors in starting your Nuxt application.
 
 This includes:
-- running [Nuxt plugins](/docs/guide/directory-structure/plugins)
+- running [Nuxt plugins](/docs/3.x/guide/directory-structure/plugins)
 - processing `app:created` and `app:beforeMount` hooks
 - rendering your Vue app to HTML (during SSR)
 - mounting the app (on client-side), though you should handle this case with `onErrorCaptured` or with `vue:error`
@@ -91,7 +91,7 @@ Customize the default error page by adding `~/error.vue` in the source directory
 import type { NuxtError } from '#app'
 
 const props = defineProps({
-  error: Object as () => NuxtError
+  error: Object as () => NuxtError,
 })
 
 const handleError = () => clearError({ redirect: '/' })
@@ -100,7 +100,9 @@ const handleError = () => clearError({ redirect: '/' })
 <template>
   <div>
     <h2>{{ error?.statusCode }}</h2>
-    <button @click="handleError">Clear errors</button>
+    <button @click="handleError">
+      Clear errors
+    </button>
   </div>
 </template>
 ```
@@ -112,14 +114,14 @@ Read more about `error.vue` and its uses.
 For custom errors we highly recommend using `onErrorCaptured` composable that can be called in a page/component setup function or `vue:error` runtime nuxt hook that can be configured in a nuxt plugin.
 
 ```ts twoslash [plugins/error-handler.ts]
-export default defineNuxtPlugin(nuxtApp => {
+export default defineNuxtPlugin((nuxtApp) => {
   nuxtApp.hook('vue:error', (err) => {
     //
   })
 })
 ```
 
-When you are ready to remove the error page, you can call the [`clearError`](/docs/api/utils/clear-error) helper function, which takes an optional path to redirect to (for example, if you want to navigate to a 'safe' page).
+When you are ready to remove the error page, you can call the [`clearError`](/docs/3.x/api/utils/clear-error) helper function, which takes an optional path to redirect to (for example, if you want to navigate to a 'safe' page).
 
 ::important
 Make sure to check before using anything dependent on Nuxt plugins, such as `$route` or `useRouter`, as if a plugin threw an error, then it won't be re-run until you clear the error.
@@ -167,7 +169,7 @@ const { data } = await useFetch(`/api/movies/${route.params.slug}`)
 if (!data.value) {
   throw createError({
     statusCode: 404,
-    statusMessage: 'Page Not Found'
+    statusMessage: 'Page Not Found',
   })
 }
 </script>
@@ -205,7 +207,7 @@ Read more about `clearError` util.
 
 ## Render Error in Component
 
-Nuxt also provides a [`<NuxtErrorBoundary>`](/docs/api/components/nuxt-error-boundary) component that allows you to handle client-side errors within your app, without replacing your entire site with an error page.
+Nuxt also provides a [`<NuxtErrorBoundary>`](/docs/3.x/api/components/nuxt-error-boundary) component that allows you to handle client-side errors within your app, without replacing your entire site with an error page.
 
 This component is responsible for handling errors that occur within its default slot. On client-side, it will prevent the error from bubbling up to the top level, and will render the `#error` slot instead.