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

package/3.api/3.utils/refresh-nuxt-data.md

@@ -16,8 +16,8 @@ If your component is cached by `<KeepAlive>` and enters a deactivated state, the
 
 ## Type
 
-```ts
-refreshNuxtData(keys?: string | string[])
+```ts [Signature]
+export function refreshNuxtData (keys?: string | string[])
 ```
 
 ## Parameters
@@ -50,7 +50,10 @@ async function refreshAll () {
 
 <template>
   <div>
-    <button :disabled="refreshing" @click="refreshAll">
+    <button
+      :disabled="refreshing"
+      @click="refreshAll"
+    >
       Refetch All Data
     </button>
   </div>
@@ -80,7 +83,9 @@ async function refresh () {
   <div v-if="refreshing">
     Loading
   </div>
-  <button @click="refresh">Refresh</button>
+  <button @click="refresh">
+    Refresh
+  </button>
 </template>
 ```
 
@@ -88,4 +93,4 @@ async function refresh () {
 If you have access to the `asyncData` instance, it is recommended to use its `refresh` or `execute` method as the preferred way to refetch the data.
 ::
 
-:read-more{to="/docs/getting-started/data-fetching"}
+:read-more{to="/docs/4.x/getting-started/data-fetching"}

package/3.api/3.utils/reload-nuxt-app.md

@@ -14,14 +14,14 @@ links:
 
 By default, it will also save the current `state` of your app (that is, any state you could access with `useState`).
 
-::read-more{to="/docs/guide/going-further/experimental-features#restorestate" icon="i-lucide-star"}
+::read-more{to="/docs/4.x/guide/going-further/experimental-features#restorestate" icon="i-lucide-star"}
 You can enable experimental restoration of this state by enabling the `experimental.restoreState` option in your `nuxt.config` file.
 ::
 
 ## Type
 
-```ts
-reloadNuxtApp(options?: ReloadNuxtAppOptions)
+```ts [Signature]
+export function reloadNuxtApp (options?: ReloadNuxtAppOptions)
 
 interface ReloadNuxtAppOptions {
   ttl?: number

package/3.api/3.utils/set-response-status.md

@@ -16,7 +16,7 @@ Nuxt provides composables and utilities for first-class server-side-rendering su
 `setResponseStatus` can only be called in the [Nuxt context](/docs/4.x/guide/going-further/nuxt-app#the-nuxt-context).
 ::
 
-```js
+```ts
 const event = useRequestEvent()
 
 // event will be undefined in the browser
@@ -33,4 +33,4 @@ if (event) {
 In the browser, `setResponseStatus` will have no effect.
 ::
 
-:read-more{to="/docs/getting-started/error-handling"}
+:read-more{to="/docs/4.x/getting-started/error-handling"}

package/3.api/3.utils/show-error.md

@@ -15,10 +15,10 @@ Within the [Nuxt context](/docs/4.x/guide/going-further/nuxt-app#the-nuxt-contex
 - `error`: `string | Error | Partial<{ cause, data, message, name, stack, statusCode, statusMessage }>`
 
 ```ts
-showError("😱 Oh no, an error has been thrown.")
+showError('😱 Oh no, an error has been thrown.')
 showError({
   statusCode: 404,
-  statusMessage: "Page Not Found"
+  statusMessage: 'Page Not Found',
 })
 ```
 
@@ -28,4 +28,4 @@ The error is set in the state using [`useError()`](/docs/4.x/api/composables/use
 `showError` calls the `app:error` hook.
 ::
 
-:read-more{to="/docs/getting-started/error-handling"}
+:read-more{to="/docs/4.x/getting-started/error-handling"}

package/3.api/3.utils/update-app-config.md

@@ -15,13 +15,14 @@ Updates the [`app.config`](/docs/4.x/guide/directory-structure/app-config) using
 ## Usage
 
 ```js
+import { updateAppConfig, useAppConfig } from '#imports'
+
 const appConfig = useAppConfig() // { foo: 'bar' }
 
 const newAppConfig = { foo: 'baz' }
-
 updateAppConfig(newAppConfig)
 
 console.log(appConfig) // { foo: 'baz' }
 ```
 
-:read-more{to="/docs/guide/directory-structure/app-config"}
+:read-more{to="/docs/4.x/guide/directory-structure/app-config"}

package/3.api/4.commands/generate.md

@@ -36,6 +36,6 @@ Option | Default | Description
 `--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
 <!--/generate-opts-->
 
-::read-more{to="/docs/getting-started/deployment#static-hosting"}
+::read-more{to="/docs/4.x/getting-started/deployment#static-hosting"}
 Read more about pre-rendering and static hosting.
 ::

package/3.api/4.commands/prepare.md

@@ -34,3 +34,7 @@ Option | Default | Description
 `--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
 `--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
 <!--/prepare-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `production`.
+::

package/3.api/4.commands/typecheck.md

@@ -37,6 +37,6 @@ Option | Default | Description
 This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a [`.env`](/docs/4.x/guide/directory-structure/env) file or as a command-line argument.
 ::
 
-::read-more{to="/docs/guide/concepts/typescript#type-checking"}
+::read-more{to="/docs/4.x/guide/concepts/typescript#type-checking"}
 Read more on how to enable type-checking at build or development time.
 ::

package/3.api/5.kit/1.modules.md

@@ -22,16 +22,16 @@ import { defineNuxtModule } from '@nuxt/kit'
 export default defineNuxtModule({
   meta: {
     name: 'my-module',
-    configKey: 'myModule'
+    configKey: 'myModule',
   },
   defaults: {
-    enabled: true
+    enabled: true,
   },
   setup (options) {
     if (options.enabled) {
       console.log('My Nuxt module is enabled!')
     }
-  }
+  },
 })
 ```
 
@@ -78,17 +78,17 @@ import { defineNuxtModule } from '@nuxt/kit'
 export default defineNuxtModule({
   meta: {
     name: 'my-module',
-    configKey: 'myModule'
+    configKey: 'myModule',
   },
   defaults: {
     // Module options
-    enabled: true
+    enabled: true,
   },
   setup (options) {
     if (options.enabled) {
       console.log('My Nuxt module is enabled!')
     }
-  }
+  },
 })
 ```
 
@@ -97,8 +97,8 @@ Users can provide options for this module under the corresponding key in `nuxt.c
 ```ts
 export default defineNuxtConfig({
   myModule: {
-    enabled: false
-  }
+    enabled: false,
+  },
 })
 ```
 
@@ -116,7 +116,7 @@ export default defineNuxtModule({
       nuxt: '>=3.0.0', // or use '^3.0.0'
     },
   },
-  async setup() {
+  setup () {
     const resolver = createResolver(import.meta.url)
     // Implement
   },
@@ -148,26 +148,26 @@ interface ModuleOptions {
 export default defineNuxtModule<ModuleOptions>().with({
   meta: {
     name: '@nuxtjs/my-api',
-    configKey: 'myApi'
+    configKey: 'myApi',
   },
   defaults: {
     baseURL: 'https://api.example.com',
     timeout: 5000,
-    retries: 3
+    retries: 3,
   },
-  setup(resolvedOptions, nuxt) {
+  setup (resolvedOptions, nuxt) {
     // resolvedOptions is properly typed as:
     // {
     //   apiKey: string          // Required, no default provided
     //   baseURL: string         // Required, has default value
     //   timeout: number         // Optional, has default value
-    //   retries: number         // Optional, has default value  
+    //   retries: number         // Optional, has default value
     // }
-    
+
     console.log(resolvedOptions.baseURL) // ✅ TypeScript knows this is always defined
     console.log(resolvedOptions.timeout) // ✅ TypeScript knows this is always defined
     console.log(resolvedOptions.retries) // ✅ TypeScript knows this is always defined
-  }
+  },
 })
 ```
 
@@ -197,45 +197,45 @@ export default defineNuxtModule({
   meta: {
     name: 'my-awesome-module',
     version: '1.2.0', // Required for lifecycle hooks
-    configKey: 'myAwesomeModule'
+    configKey: 'myAwesomeModule',
   },
   defaults: {
     apiKey: '',
-    enabled: true
+    enabled: true,
   },
-  
-  onInstall(nuxt) {
+
+  onInstall (nuxt) {
     // This runs only when the module is first installed
     console.log('Setting up my-awesome-module for the first time!')
-    
+
     // You might want to:
     // - Create initial configuration files
     // - Set up database schemas
     // - Display welcome messages
     // - Perform initial data migration
   },
-  
-  onUpgrade(options, nuxt, previousVersion) {
+
+  onUpgrade (options, nuxt, previousVersion) {
     // This runs when the module is upgraded to a newer version
     console.log(`Upgrading my-awesome-module from ${previousVersion} to 1.2.0`)
-    
+
     // You might want to:
     // - Migrate configuration files
-    // - Update database schemas  
+    // - Update database schemas
     // - Clean up deprecated files
     // - Display upgrade notes
-    
+
     if (semver.lt(previousVersion, '1.1.0')) {
       console.log('⚠️  Breaking changes in 1.1.0 - please check the migration guide')
     }
   },
-  
-  setup(options, nuxt) {
+
+  setup (options, nuxt) {
     // Regular setup logic runs on every build
     if (options.enabled) {
       // Configure the module
     }
-  }
+  },
 })
 ```
 
@@ -248,7 +248,7 @@ Install specified Nuxt module programmatically. This is helpful when your module
 ```ts twoslash
 import { defineNuxtModule, installModule } from '@nuxt/kit'
 
-export default defineNuxtModule({  
+export default defineNuxtModule({
   async setup () {
     // will install @nuxtjs/fontaine with Roboto font and Impact fallback
     await installModule('@nuxtjs/fontaine', {
@@ -258,10 +258,10 @@ export default defineNuxtModule({
           family: 'Roboto',
           fallbacks: ['Impact'],
           fallbackName: 'fallback-a',
-        }
-      ]
+        },
+      ],
     })
-  }
+  },
 })
 ```
 
@@ -284,7 +284,7 @@ async function installModule (moduleToInstall: string | NuxtModule, inlineOption
 ```ts
 import { defineNuxtModule, installModule } from '@nuxt/kit'
 
-export default defineNuxtModule({  
+export default defineNuxtModule({
   async setup (options, nuxt) {
     // will install @nuxtjs/fontaine with Roboto font and Impact fallback
     await installModule('@nuxtjs/fontaine', {
@@ -294,9 +294,9 @@ export default defineNuxtModule({
           family: 'Roboto',
           fallbacks: ['Impact'],
           fallbackName: 'fallback-a',
-        }
-      ]
+        },
+      ],
     })
-  }
+  },
 })
 ```

package/3.api/5.kit/10.templates.md

@@ -21,17 +21,17 @@ import { addTemplate, defineNuxtModule } from '@nuxt/kit'
 import { defu } from 'defu'
 
 export default defineNuxtModule({
-  setup(options, nuxt) {
+  setup (options, nuxt) {
     const globalMeta = defu(nuxt.options.app.head, {
       charset: options.charset,
-      viewport: options.viewport
+      viewport: options.viewport,
     })
 
     addTemplate({
       filename: 'meta.config.mjs',
-      getContents: () => 'export default ' + JSON.stringify({ globalMeta, mixinKey: 'setup' })
+      getContents: () => 'export default ' + JSON.stringify({ globalMeta, mixinKey: 'setup' }),
     })
-  }
+  },
 })
 ```
 
@@ -88,7 +88,7 @@ In the module above, we generate a virtual file named `meta.config.mjs`. In the
 import { createHead as createServerHead } from '@unhead/vue/server'
 import { createHead as createClientHead } from '@unhead/vue/client'
 import { defineNuxtPlugin } from '#imports'
-// @ts-ignore
+// @ts-expect-error - virtual file
 import metaConfig from '#build/meta.config.mjs'
 
 export default defineNuxtPlugin((nuxtApp) => {
@@ -279,7 +279,9 @@ export default defineNuxtModule({
     ]
     // watch and rebuild routes template list when one of the pages changes
     nuxt.hook('builder:watch', async (event, relativePath) => {
-      if (event === 'change') { return }
+      if (event === 'change') {
+        return
+      }
 
       const path = resolve(nuxt.options.srcDir, relativePath)
       if (updateTemplatePaths.some(dir => path.startsWith(dir))) {