@nuxt/docs-nightly 4.1.3-29313386.edc02e27 → 4.1.3-29316215.910d159d

package/2.guide/1.directory-structure/1.shared.md

@@ -52,7 +52,7 @@ const hello = capitalize('hello')
 ```ts [server/api/hello.get.ts]
 export default defineEventHandler((event) => {
   return {
-    hello: capitalize('hello')
+    hello: capitalize('hello'),
   }
 })
 ```
@@ -65,7 +65,7 @@ Only files in the `shared/utils/` and `shared/types/` directories will be auto-i
 The way `shared/utils` and `shared/types` auto-imports work and are scanned is identical to the [`app/composables/`](/docs/4.x/guide/directory-structure/app/composables) and [`app/utils/`](/docs/4.x/guide/directory-structure/app/utils) directories.
 ::
 
-:read-more{to="/docs/guide/directory-structure/app/composables#how-files-are-scanned"}
+:read-more{to="/docs/4.x/guide/directory-structure/app/composables#how-files-are-scanned"}
 
 ```bash [Directory Structure]
 -| shared/
@@ -95,4 +95,4 @@ import upper from '#shared/utils/formatters/upper'
 
 This alias ensures consistent imports across your application, regardless of the importing file's location.
 
-:read-more{to="/docs/guide/concepts/auto-imports"}
+:read-more{to="/docs/4.x/guide/concepts/auto-imports"}

package/2.guide/1.directory-structure/2.env.md

@@ -56,7 +56,7 @@ Since `.env` files are not used in production, you must explicitly set environme
 * Many cloud service providers, such as Vercel, Netlify, and AWS, provide interfaces for setting environment variables via their dashboards, CLI tools or configuration files.
 
 ::important
-`runtimeConfig` [won't pick up environment variables that don't start with `NUXT_` in production] (https://nuxt.com/docs/guide/going-further/runtime-config#environment-variables).
+`runtimeConfig` [won't pick up environment variables that don't start with `NUXT_` in production] (https://nuxt.com/docs/4.x/guide/going-further/runtime-config#environment-variables).
 ::
 
 ## Production Preview
@@ -71,9 +71,9 @@ DATABASE_HOST=mydatabaseconnectionstring node .output/server/index.mjs
 
 Note that for a purely static site, it is not possible to set runtime configuration config after your project is prerendered.
 
-:read-more{to="/docs/guide/going-further/runtime-config"}
+:read-more{to="/docs/4.x/guide/going-further/runtime-config"}
 
 ::note
 If you want to use environment variables set at build time but do not care about updating these down the line (or only need to update them reactively _within_ your app) then `appConfig` may be a better choice. You can define `appConfig` both within your `nuxt.config` (using environment variables) and also within an `~/app.config.ts` file in your project.
-:read-more{to="/docs/guide/directory-structure/app-config"}
+:read-more{to="/docs/4.x/guide/directory-structure/app-config"}
 ::

package/2.guide/1.directory-structure/2.nuxtrc.md

@@ -31,7 +31,7 @@ If present, the properties in the `nuxt.config` file will overwrite the properti
 Nuxt automatically adds a `setups` section to track module installation and upgrade state. This is used internally for [module lifecycle hooks](/docs/4.x/api/kit/modules#using-lifecycle-hooks-for-module-installation-and-upgrade) and should not be modified manually.
 ::
 
-::read-more{to="/docs/api/configuration/nuxt-config"}
+::read-more{to="/docs/4.x/api/configuration/nuxt-config"}
 Discover all the available options in the **Nuxt configuration** documentation.
 ::
 

package/2.guide/1.directory-structure/3.nuxt-config.md

@@ -27,7 +27,7 @@ export default defineNuxtConfig({
 })
 ```
 
-::read-more{to="/docs/api/configuration/nuxt-config"}
+::read-more{to="/docs/4.x/api/configuration/nuxt-config"}
 Discover all the available options in the **Nuxt configuration** documentation.
 ::
 

package/2.guide/2.concepts/1.auto-imports.md

@@ -66,7 +66,7 @@ If you get an error message like `Nuxt instance is unavailable` then it probably
 When using a composable that requires the Nuxt context inside a non-SFC component, you need to wrap your component with `defineNuxtComponent` instead of `defineComponent`
 ::
 
-::read-more{to="/docs/guide/going-further/experimental-features#asynccontext" icon="i-lucide-star"}
+::read-more{to="/docs/4.x/guide/going-further/experimental-features#asynccontext" icon="i-lucide-star"}
 Checkout the `asyncContext` experimental feature to use Nuxt composables in async functions.
 ::
 
@@ -105,7 +105,7 @@ Nuxt directly auto-imports files created in defined directories:
 - `app/composables/` for [Vue composables](/docs/4.x/guide/directory-structure/app/composables).
 - `app/utils/` for helper functions and other utilities.
 
-:link-example{to="/docs/examples/features/auto-imports"}
+:link-example{to="/docs/4.x/examples/features/auto-imports"}
 
 ::warning
 **Auto-imported `ref` and `computed` won't be unwrapped in a component `<template>`.** :br
@@ -120,7 +120,7 @@ Nuxt exposes every auto-import with the `#imports` alias that can be used to mak
 
 ```vue
 <script setup lang="ts">
-import { ref, computed } from '#imports'
+import { computed, ref } from '#imports'
 
 const count = ref(1)
 const double = computed(() => count.value * 2)
@@ -134,12 +134,12 @@ If you want to disable auto-importing composables and utilities, you can set `im
 ```ts twoslash [nuxt.config.ts]
 export default defineNuxtConfig({
   imports: {
-    autoImport: false
-  }
+    autoImport: false,
+  },
 })
 ```
 
-This will disable auto-imports completely but it's still possible to use [explicit imports](/docs/guide/concepts/auto-imports#explicit-imports) from `#imports`.
+This will disable auto-imports completely but it's still possible to use [explicit imports](/docs/4.x/guide/concepts/auto-imports#explicit-imports) from `#imports`.
 
 ### Partially Disabling Auto-imports
 
@@ -148,8 +148,8 @@ If you want framework-specific functions like `ref` to remain auto-imported but
 ```ts
 export default defineNuxtConfig({
   imports: {
-    scan: false
-  }
+    scan: false,
+  },
 })
 ```
 
@@ -167,15 +167,15 @@ With this configuration:
 
 Nuxt also automatically imports components from your `~/components` directory, although this is configured separately from auto-importing composables and utility functions.
 
-:read-more{to="/docs/guide/directory-structure/app/components"}
+:read-more{to="/docs/4.x/guide/directory-structure/app/components"}
 
 To disable auto-importing components from your own `~/components` directory, you can set `components.dirs` to an empty array (though note that this will not affect components added by modules).
 
 ```ts twoslash [nuxt.config.ts]
 export default defineNuxtConfig({
   components: {
-    dirs: []
-  }
+    dirs: [],
+  },
 })
 ```
 
@@ -195,10 +195,10 @@ export default defineNuxtConfig({
     presets: [
       {
         from: 'vue-i18n',
-        imports: ['useI18n']
-      }
-    ]
-  }
+        imports: ['useI18n'],
+      },
+    ],
+  },
 })
 ```
 

package/2.guide/2.concepts/10.nuxt-lifecycle.md

@@ -22,7 +22,7 @@ When Nitro starts, it initializes and executes the plugins under the `/server/pl
 Nitro plugins are executed only once when the server starts. In a serverless environment, the server boots on each incoming request, and so do the Nitro plugins. However, they are not awaited.
 ::
 
-:read-more{to="/docs/guide/directory-structure/server#server-plugins"}
+:read-more{to="/docs/4.x/guide/directory-structure/server#server-plugins"}
 
 ### Step 2: Nitro Server Middleware
 
@@ -32,7 +32,7 @@ After initializing the Nitro server, middleware under `server/middleware/` is ex
 Returning a value from middleware will terminate the request and send the returned value as the response. This behavior should generally be avoided to ensure proper request handling!
 ::
 
-:read-more{to="/docs/guide/directory-structure/server#server-middleware"}
+:read-more{to="/docs/4.x/guide/directory-structure/server#server-middleware"}
 
 ### Step 3: Initialize Nuxt and Execute Nuxt App Plugins
 
@@ -46,7 +46,7 @@ Plugins execute in a specific order and may have dependencies on one another. Fo
 After this step, Nuxt calls the [`app:created`](/docs/4.x/api/advanced/hooks#app-hooks-runtime) hook, which can be used to execute additional logic.
 ::
 
-:read-more{to="/docs/guide/directory-structure/plugins"}
+:read-more{to="/docs/4.x/guide/directory-structure/plugins"}
 
 ### Step 4: Route Validation
 
@@ -57,7 +57,7 @@ After initializing plugins and before executing middleware, Nuxt calls the `vali
 
 For more information, see the [Route Validation documentation](/docs/4.x/getting-started/routing#route-validation).
 
-:read-more{to="/docs/getting-started/routing#route-validation"}
+:read-more{to="/docs/4.x/getting-started/routing#route-validation"}
 
 ### Step 5: Execute Nuxt App Middleware
 
@@ -74,7 +74,7 @@ For details about each type and examples, see the [Middleware documentation](/do
 
 Any redirection on the server will result in a `Location:` header being sent to the browser; the browser then makes a fresh request to this new location. All application state will be reset when this happens, unless persisted in a cookie.
 
-:read-more{to="/docs/guide/directory-structure/app/middleware"}
+:read-more{to="/docs/4.x/guide/directory-structure/app/middleware"}
 
 ### Step 6: Render Page and Components
 
@@ -120,7 +120,7 @@ Custom plugins in the `app/plugins/` directory, such as those without a suffix (
 After this step, Nuxt calls the [`app:created`](/docs/4.x/api/advanced/hooks#app-hooks-runtime) hook, which can be used to execute additional logic.
 ::
 
-:read-more{to="/docs/guide/directory-structure/plugins"}
+:read-more{to="/docs/4.x/guide/directory-structure/plugins"}
 
 ### Step 2: Route Validation
 
@@ -130,7 +130,7 @@ This step is the same as the server-side execution and includes the `validate` m
 
 Nuxt middleware runs on both the server and the client. If you want certain code to run in specific environments, consider splitting it by using `import.meta.client` for the client and `import.meta.server` for the server.
 
-:read-more{to="/docs/guide/directory-structure/app/middleware#when-middleware-runs"}
+:read-more{to="/docs/4.x/guide/directory-structure/app/middleware#when-middleware-runs"}
 
 ### Step 4: Mount Vue Application and Hydration
 

package/2.guide/2.concepts/2.vuejs-development.md

@@ -27,15 +27,15 @@ We chose to build Nuxt on top of Vue for these reasons:
 
 Every Vue component created in the [`app/components/`](/docs/4.x/guide/directory-structure/app/components) directory of a Nuxt project will be available in your project without having to import it. If a component is not used anywhere, your production’s code will not include it.
 
-:read-more{to="/docs/guide/concepts/auto-imports"}
+:read-more{to="/docs/4.x/guide/concepts/auto-imports"}
 
 ### Vue Router
 
 Most applications need multiple pages and a way to navigate between them. This is called **routing**. Nuxt uses an [`app/pages/`](/docs/4.x/guide/directory-structure/app/pages) directory and naming conventions to directly create routes mapped to your files using the official [Vue Router library](https://router.vuejs.org).
 
-:read-more{to="/docs/getting-started/routing"}
+:read-more{to="/docs/4.x/getting-started/routing"}
 
-:link-example{to="/docs/examples/features/auto-imports"}
+:link-example{to="/docs/4.x/examples/features/auto-imports"}
 
 ## Differences with Nuxt 2 / Vue 2
 
@@ -64,16 +64,16 @@ The only way to provide data and logic to components in Vue 2 was through the Op
 ```vue twoslash
 <script>
 export default {
-  data() {
+  data () {
     return {
-      count: 0
+      count: 0,
     }
   },
   methods: {
-    increment(){
+    increment () {
       this.count++
-    }
-  }
+    },
+  },
 }
 </script>
 ```
@@ -98,6 +98,6 @@ The goal of Nuxt is to provide a great developer experience around the Compositi
 
 Both Vue 3 and Nuxt 3+ are written in TypeScript. A fully typed codebase prevents mistakes and documents APIs usage. This doesn’t mean that you have to write your application in TypeScript to take advantage of it. With Nuxt 3, you can opt-in by renaming your file from `.js` to `.ts` , or add `<script setup lang="ts">` in a component.
 
-::read-more{to="/docs/guide/concepts/typescript"}
+::read-more{to="/docs/4.x/guide/concepts/typescript"}
 Read the details about TypeScript in Nuxt
 ::

package/2.guide/2.concepts/3.rendering.md

@@ -3,7 +3,7 @@ title: 'Rendering Modes'
 description: 'Learn about the different rendering modes available in Nuxt.'
 ---
 
-Nuxt supports different rendering modes, [universal rendering](/docs/guide/concepts/rendering#universal-rendering), [client-side rendering](/docs/guide/concepts/rendering#client-side-rendering) but also offers [hybrid-rendering](/docs/guide/concepts/rendering#hybrid-rendering) and the possibility to render your application on [CDN Edge Servers](/docs/guide/concepts/rendering#edge-side-rendering).
+Nuxt supports different rendering modes, [universal rendering](/docs/4.x/guide/concepts/rendering#universal-rendering), [client-side rendering](/docs/4.x/guide/concepts/rendering#client-side-rendering) but also offers [hybrid-rendering](/docs/4.x/guide/concepts/rendering#hybrid-rendering) and the possibility to render your application on [CDN Edge Servers](/docs/4.x/guide/concepts/rendering#edge-side-rendering).
 
 Both the browser and server can interpret JavaScript code to turn Vue.js components into HTML elements. This step is called **rendering**. Nuxt supports both **universal** and **client-side** rendering. The two approaches have benefits and downsides that we will cover.
 
@@ -25,17 +25,19 @@ It is normal to ask which parts of a Vue file runs on the server and/or the clie
 
 ```vue [app/app.vue]
 <script setup lang="ts">
-const counter = ref(0); // executes in server and client environments
+const counter = ref(0) // executes in server and client environments
 
 const handleClick = () => {
-  counter.value++; // executes only in a client environment
-};
+  counter.value++ // executes only in a client environment
+}
 </script>
 
 <template>
   <div>
     <p>Count: {{ counter }}</p>
-    <button @click="handleClick">Increment</button>
+    <button @click="handleClick">
+      Increment
+    </button>
   </div>
 </template>
 ```
@@ -50,7 +52,7 @@ On the initial request, the `counter` ref is initialized in the server since it
 
 **Downsides of server-side rendering:**
 - **Development constraints:** Server and browser environments don't provide the same APIs, and it can be tricky to write code that can run on both sides seamlessly. Fortunately, Nuxt provides guidelines and specific variables to help you determine where a piece of code is executed.
-- **Cost:** A server needs to be running in order to render pages on the fly. This adds a monthly cost like any traditional server. However, the server calls are highly reduced thanks to universal rendering with the browser taking over on client-side navigation. A cost reduction is possible by leveraging [edge-side-rendering](/docs/guide/concepts/rendering#edge-side-rendering).
+- **Cost:** A server needs to be running in order to render pages on the fly. This adds a monthly cost like any traditional server. However, the server calls are highly reduced thanks to universal rendering with the browser taking over on client-side navigation. A cost reduction is possible by leveraging [edge-side-rendering](/docs/4.x/guide/concepts/rendering#edge-side-rendering).
 
 Universal rendering is very versatile and can fit almost any use case, and is especially appropriate for any content-oriented websites: **blogs, marketing websites, portfolios, e-commerce sites, and marketplaces.**
 
@@ -83,13 +85,13 @@ You can enable client-side only rendering with Nuxt in your `nuxt.config.ts`:
 
 ```ts [nuxt.config.ts]
 export default defineNuxtConfig({
-  ssr: false
+  ssr: false,
 })
 ```
 
 ::note
 If you do use `ssr: false`, you should also place an HTML file in `~/spa-loading-template.html` with some HTML you would like to use to render a loading screen that will be rendered until your app is hydrated.
-:read-more{title="SPA Loading Template" to="/docs/api/configuration/nuxt-config#spaloadingtemplate"}
+:read-more{title="SPA Loading Template" to="/docs/4.x/api/configuration/nuxt-config#spaloadingtemplate"}
 ::
 
 :video-accordion{title="Watch a video from Alexander Lichter about Building a plain SPA with Nuxt" videoId="7Lr0QTP1Ro8"}
@@ -111,7 +113,7 @@ export default defineNuxtConfig({
   hooks: {
     'prerender:routes' ({ routes }) {
       routes.clear() // Do not generate any routes (except the defaults)
-    }
+    },
   },
 })
 ```
@@ -133,14 +135,14 @@ export default defineNuxtConfig({
   ssr: false,
   nitro: {
     hooks: {
-      'prerender:generate'(route) {
+      'prerender:generate' (route) {
         const routesToSkip = ['/index.html', '/200.html', '/404.html']
         if (routesToSkip.includes(route.route)) {
           route.skip = true
         }
-      }
-    }
-  }
+      },
+    },
+  },
 })
 ```
 
@@ -172,8 +174,8 @@ export default defineNuxtConfig({
     // Add cors headers on API routes
     '/api/**': { cors: true },
     // Redirects legacy urls
-    '/old-page': { redirect: '/new-page' }
-  }
+    '/old-page': { redirect: '/new-page' },
+  },
 })
 ```
 

package/2.guide/2.concepts/4.server-engine.md

@@ -26,7 +26,7 @@ Key features include:
 
 Check out [the h3 docs](https://github.com/h3js/h3) for more information.
 
-::read-more{to="/docs/guide/directory-structure/server#server-routes"}
+::read-more{to="/docs/4.x/guide/directory-structure/server#server-routes"}
 Learn more about the API layer in the `server/` directory.
 ::
 

package/2.guide/2.concepts/5.modules.md

@@ -32,8 +32,8 @@ export default defineNuxtConfig({
     ['./modules/example', { token: '123' }],
 
     // Inline module definition
-    async (inlineOptions, nuxt) => { }
-  ]
+    async (inlineOptions, nuxt) => { },
+  ],
 })
 ```
 
@@ -45,4 +45,4 @@ Nuxt modules are now build-time-only, and the `buildModules` property used in Nu
 
 Everyone has the opportunity to develop modules and we cannot wait to see what you will build.
 
-:read-more{to="/docs/guide/going-further/modules" title="Module Author Guide"}
+:read-more{to="/docs/4.x/guide/going-further/modules" title="Module Author Guide"}

package/2.guide/2.concepts/7.esm.md

@@ -111,7 +111,7 @@ const { named } = pkg;
 
 ## Troubleshooting ESM Issues
 
-If you encounter these errors, the issue is almost certainly with the upstream library. They need to [fix their library](/docs/guide/concepts/esm#library-author-guide) to support being imported by Node.
+If you encounter these errors, the issue is almost certainly with the upstream library. They need to [fix their library](/docs/4.x/guide/concepts/esm#library-author-guide) to support being imported by Node.
 
 ### Transpiling Libraries
 
@@ -120,8 +120,8 @@ In the meantime, you can tell Nuxt not to try to import these libraries by addin
 ```ts twoslash
 export default defineNuxtConfig({
   build: {
-    transpile: ['sample-library']
-  }
+    transpile: ['sample-library'],
+  },
 })
 ```
 
@@ -134,8 +134,8 @@ In some cases, you may also need to manually alias the library to the CJS versio
 ```ts twoslash
 export default defineNuxtConfig({
   alias: {
-    'sample-library': 'sample-library/dist/sample-library.cjs.js'
-  }
+    'sample-library': 'sample-library/dist/sample-library.cjs.js',
+  },
 })
 ```
 
@@ -182,6 +182,8 @@ import('cjs-pkg').then(console.log) // [Module: null prototype] { default: { tes
 
 In this case, we need to manually interop the default export:
 
+<!-- eslint-disable import/no-named-default -->
+
 ```js
 // Static import
 import { default as pkg } from 'cjs-pkg'
@@ -219,16 +221,16 @@ The initial step from CJS to ESM is updating any usage of `require` to use `impo
 
 ::code-group
 
-```js [Before]
-module.exports = ...
+```ts [Before]
+module.exports = function () { /* ... */ }
 
-exports.hello = ...
+exports.hello = 'world'
 ```
 
-```js [After]
-export default ...
+```ts [After]
+export default function () { /* ... */ }
 
-export const hello = ...
+export const hello = 'world'
 ```
 
 ::
@@ -242,7 +244,7 @@ const myLib = require('my-lib')
 ```js [After]
 import myLib from 'my-lib'
 // or
-const myLib = await import('my-lib').then(lib => lib.default || lib)
+const dynamicMyLib = await import('my-lib').then(lib => lib.default || lib)
 ```
 
 ::
@@ -253,7 +255,7 @@ and should be replaced with `import()` and `import.meta.filename`.
 ::code-group
 
 ```js [Before]
-import { join } from 'path'
+const { join } = require('node:path')
 
 const newDir = join(__dirname, 'new-dir')
 ```
@@ -282,7 +284,7 @@ const someFile = await resolvePath('my-lib', { url: import.meta.url })
 
 ### Best Practices
 
-- Prefer named exports rather than default export. This helps reduce CJS conflicts. (see [Default exports](/docs/guide/concepts/esm#default-exports) section)
+- Prefer named exports rather than default export. This helps reduce CJS conflicts. (see [Default exports](/docs/4.x/guide/concepts/esm#default-exports) section)
 
 - Avoid depending on Node.js built-ins and CommonJS or Node.js-only dependencies as much as possible to make your library usable in Browsers and Edge Workers without needing Nitro polyfills.
 

package/2.guide/2.concepts/8.typescript.md

@@ -40,8 +40,8 @@ To enable type-checking at build or development time, you can also use the [`typ
 ```ts twoslash [nuxt.config.ts]
 export default defineNuxtConfig({
   typescript: {
-    typeCheck: true
-  }
+    typeCheck: true,
+  },
 })
 ```
 
@@ -133,7 +133,7 @@ If you are currently converting your codebase to TypeScript, you may want to tem
 ```ts twoslash [nuxt.config.ts]
 export default defineNuxtConfig({
   typescript: {
-    strict: false
-  }
+    strict: false,
+  },
 })
 ```

package/2.guide/3.going-further/1.events.md

@@ -16,7 +16,7 @@ You can create your own custom events using the `hook` method:
 ```ts
 const nuxtApp = useNuxtApp()
 
-nuxtApp.hook('app:user:registered', payload => {
+nuxtApp.hook('app:user:registered', (payload) => {
   console.log('A new user has registered!', payload)
 })
 ```
@@ -37,7 +37,7 @@ You can also use the payload object to enable two-way communication between the
 ```ts
 const nuxtApp = useNuxtApp()
 
-nuxtApp.hook('app:user:registered', payload => {
+nuxtApp.hook('app:user:registered', (payload) => {
   payload.message = 'Welcome to our app!'
 })
 
@@ -58,6 +58,6 @@ await nuxtApp.callHook('app:user:registered', {
 You can inspect all events using the **Nuxt DevTools** Hooks panel.
 ::
 
-::read-more{to="/docs/guide/going-further/hooks"}
+::read-more{to="/docs/4.x/guide/going-further/hooks"}
 Learn more about Nuxt's built-in hooks and how to extend them
 ::