@nuxt/docs-nightly 4.0.0-29161999.4b56bb92 → 4.0.0-29162105.8c587084

package/3.api/2.composables/use-cookie.md

@@ -168,9 +168,8 @@ const user = useCookie(
   }
 )
 
-if (user.value) {
-  // the actual `userInfo` cookie will not be updated
-  user.value.score++
+if (user.value && user.value !== null) {
+  user.value.score++; // userInfo cookie not update with this change
 }
 </script>
 
@@ -197,9 +196,9 @@ function add() {
 }
 
 function save() {
-  if (list.value) {
-    // the actual `list` cookie will be updated
+  if (list.value && list.value !== null) {
     list.value = [...list.value]
+    // list cookie update with this change
   }
 }
 </script>

package/3.api/2.composables/use-fetch.md

@@ -132,7 +132,7 @@ All fetch options can be given a `computed` or `ref` value. These will be watche
     Which only caches data when `experimental.payloadExtraction` of `nuxt.config` is enabled.
   - `pick`: only pick specified keys in this array from the `handler` function result
   - `watch`: watch an array of reactive sources and auto-refresh the fetch result when they change. Fetch options and URL are watched by default. You can completely ignore reactive sources by using `watch: false`. Together with `immediate: false`, this allows for a fully-manual `useFetch`. (You can [see an example here](/docs/getting-started/data-fetching#watch) of using `watch`.)
-  - `deep`: return data in a deep ref object. It is `false` by default to return data in a shallow ref object, which can improve performance if your data does not need to be deeply reactive.
+  - `deep`: return data in a deep ref object. It is `false` by default to return data in a shallow ref object for performance.
   - `dedupe`: avoid fetching same key more than once at a time (defaults to `cancel`). Possible options:
     - `cancel` - cancels existing requests when a new one is made
     - `defer` - does not make new requests at all if there is a pending request

package/3.api/2.composables/use-preview-mode.md

@@ -103,8 +103,8 @@ const { data } = await useFetch('/api/preview', {
 Now you can generate your site and serve it:
 
 ```bash [Terminal]
-npx nuxt generate
-npx nuxt preview
+npx nuxi generate
+npx nuxi preview
 ```
 
 Then you can see your preview page by adding the query param `preview` to the end of the page you want to see once:
@@ -114,5 +114,5 @@ Then you can see your preview page by adding the query param `preview` to the en
 ```
 
 ::note
-`usePreviewMode` should be tested locally with `nuxt generate` and then `nuxt preview` rather than `nuxt dev`. (The [preview command](/docs/api/commands/preview) is not related to preview mode.)
+`usePreviewMode` should be tested locally with `nuxi generate` and then `nuxi preview` rather than `nuxi dev`. (The [preview command](/docs/api/commands/preview) is not related to preview mode.)
 ::

package/3.api/3.utils/define-page-meta.md

@@ -136,7 +136,7 @@ interface PageMeta {
 
   - **Type**: `boolean | (to: RouteLocationNormalized, from: RouteLocationNormalized) => boolean`
 
-    Tell Nuxt to scroll to the top before rendering the page or not. If you want to overwrite the default scroll behavior of Nuxt, you can do so in `~/router.options.ts` (see [custom routing](/docs/guide/recipes/custom-routing#using-approuteroptions)) for more info.
+    Tell Nuxt to scroll to the top before rendering the page or not. If you want to overwrite the default scroll behavior of Nuxt, you can do so in `~/app/router.options.ts` (see [custom routing](/docs/guide/recipes/custom-routing#using-approuteroptions)) for more info.
 
   **`[key: string]`**
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt add"
+title: "nuxi add"
 description: "Scaffold an entity into your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--add-cmd-->
 ```bash [Terminal]
-npx nuxt add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
+npx nuxi add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
 ```
 <!--/add-cmd-->
 
@@ -39,74 +39,74 @@ Some templates support additional modifier flags to add a suffix (like `.client`
 
 ```bash [Terminal]
 # Generates `/plugins/sockets.client.ts`
-npx nuxt add plugin sockets --client
+npx nuxi add plugin sockets --client
 ```
 
-## `nuxt add component`
+## `nuxi add component`
 
 * Modifier flags: `--mode client|server` or `--client` or `--server`
 
 ```bash [Terminal]
 # Generates `components/TheHeader.vue`
-npx nuxt add component TheHeader
+npx nuxi add component TheHeader
 ```
 
-## `nuxt add composable`
+## `nuxi add composable`
 
 ```bash [Terminal]
 # Generates `composables/foo.ts`
-npx nuxt add composable foo
+npx nuxi add composable foo
 ```
 
-## `nuxt add layout`
+## `nuxi add layout`
 
 ```bash [Terminal]
 # Generates `layouts/custom.vue`
-npx nuxt add layout custom
+npx nuxi add layout custom
 ```
 
-## `nuxt add plugin`
+## `nuxi add plugin`
 
 * Modifier flags: `--mode client|server` or `--client`or `--server`
 
 ```bash [Terminal]
 # Generates `plugins/analytics.ts`
-npx nuxt add plugin analytics
+npx nuxi add plugin analytics
 ```
 
-## `nuxt add page`
+## `nuxi add page`
 
 ```bash [Terminal]
 # Generates `pages/about.vue`
-npx nuxt add page about
+npx nuxi add page about
 ```
 
 ```bash [Terminal]
 # Generates `pages/category/[id].vue`
-npx nuxt add page "category/[id]"
+npx nuxi add page "category/[id]"
 ```
 
-## `nuxt add middleware`
+## `nuxi add middleware`
 
 * Modifier flags: `--global`
 
 ```bash [Terminal]
 # Generates `middleware/auth.ts`
-npx nuxt add middleware auth
+npx nuxi add middleware auth
 ```
 
-## `nuxt add api`
+## `nuxi add api`
 
 * Modifier flags: `--method` (can accept `connect`, `delete`, `get`, `head`, `options`, `patch`, `post`, `put` or `trace`) or alternatively you can directly use `--get`, `--post`, etc.
 
 ```bash [Terminal]
 # Generates `server/api/hello.ts`
-npx nuxt add api hello
+npx nuxi add api hello
 ```
 
-## `nuxt add layer`
+## `nuxi add layer`
 
 ```bash [Terminal]
 # Generates `layers/subscribe/nuxt.config.ts`
-npx nuxt add layer subscribe
+npx nuxi add layer subscribe
 ```

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt analyze"
+title: "nuxi analyze"
 description: "Analyze the production bundle or your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--analyze-cmd-->
 ```bash [Terminal]
-npx nuxt analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--name=<name>] [--no-serve]
+npx nuxi analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--name=<name>] [--no-serve]
 ```
 <!--/analyze-cmd-->
 

package/3.api/4.commands/build-module.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxt build-module'
+title: 'nuxi build-module'
 description: 'Nuxt command to build your Nuxt module before publishing.'
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--build-module-cmd-->
 ```bash [Terminal]
-npx nuxt build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
+npx nuxi build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
 ```
 <!--/build-module-cmd-->
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt build"
+title: "nuxi build"
 description: "Build your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--build-cmd-->
 ```bash [Terminal]
-npx nuxt build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName]
+npx nuxi build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName]
 ```
 <!--/build-cmd-->
 

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

@@ -1,5 +1,5 @@
 ---
-title: 'nuxt cleanup'
+title: 'nuxi cleanup'
 description: 'Remove common generated Nuxt files and caches.'
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--cleanup-cmd-->
 ```bash [Terminal]
-npx nuxt cleanup [ROOTDIR] [--cwd=<directory>]
+npx nuxi cleanup [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/cleanup-cmd-->
 

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

@@ -1,5 +1,5 @@
 ---
-title: 'nuxt dev'
+title: 'nuxi dev'
 description: The dev command starts a development server with hot module replacement at http://localhost:3000
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--dev-cmd-->
 ```bash [Terminal]
-npx nuxt dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [--no-clear] [--no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
+npx nuxi dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [--no-clear] [--no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
 ```
 <!--/dev-cmd-->
 
@@ -50,7 +50,7 @@ Option | Default | Description
 
 The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables.
 
-Additionally to the above options, `@nuxt/cli` can pass options through to `listhen`, e.g. `--no-qr` to turn off the dev server QR code. You can find the list of `listhen` options in the [unjs/listhen](https://github.com/unjs/listhen) docs.
+Additionally to the above options, `nuxi` can pass options through to `listhen`, e.g. `--no-qr` to turn off the dev server QR code. You can find the list of `listhen` options in the [unjs/listhen](https://github.com/unjs/listhen) docs.
 
 This command sets `process.env.NODE_ENV` to `development`.
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt devtools"
+title: "nuxi devtools"
 description: The devtools command allows you to enable or disable Nuxt DevTools on a per-project basis.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--devtools-cmd-->
 ```bash [Terminal]
-npx nuxt devtools <COMMAND> [ROOTDIR] [--cwd=<directory>]
+npx nuxi devtools <COMMAND> [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/devtools-cmd-->
 
-Running `nuxt devtools enable` will install the Nuxt DevTools globally, and also enable it within the particular project you are using. It is saved as a preference in your user-level `.nuxtrc`. If you want to remove devtools support for a particular project, you can run `nuxt devtools disable`.
+Running `nuxi devtools enable` will install the Nuxt DevTools globally, and also enable it within the particular project you are using. It is saved as a preference in your user-level `.nuxtrc`. If you want to remove devtools support for a particular project, you can run `nuxi devtools disable`.
 
 ## Arguments
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt generate"
+title: "nuxi generate"
 description: Pre-renders every route of the application and stores the result in plain HTML files.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--generate-cmd-->
 ```bash [Terminal]
-npx nuxt generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName]
+npx nuxi generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName]
 ```
 <!--/generate-cmd-->
 
-The `generate` command pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxt build` command with the `prerender` argument set to `true`
+The `generate` command pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxi build` command with the `prerender` argument set to `true`
 
 ## Arguments
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt info"
+title: "nuxi info"
 description: The info command logs information about the current or specified Nuxt project.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--info-cmd-->
 ```bash [Terminal]
-npx nuxt info [ROOTDIR] [--cwd=<directory>]
+npx nuxi info [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/info-cmd-->
 

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

@@ -1,5 +1,5 @@
 ---
-title: "create nuxt"
+title: "nuxi init"
 description: The init command initializes a fresh Nuxt project.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--init-cmd-->
 ```bash [Terminal]
-npm create nuxt@latest [DIR] [--cwd=<directory>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager]
+npx nuxi init [DIR] [--cwd=<directory>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager]
 ```
 <!--/init-cmd-->
 
-The `create-nuxt` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
+The `init` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
 
 ## Arguments
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt module"
+title: "nuxi module"
 description: "Search and add modules to your Nuxt application with the command line."
 links:
   - label: Source
@@ -8,13 +8,13 @@ links:
     size: xs
 ---
 
-Nuxt provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
+Nuxi provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
 
-## nuxt module add
+## nuxi module add
 
 <!--module-add-cmd-->
 ```bash [Terminal]
-npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
+npx nuxi module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
 ```
 <!--/module-add-cmd-->
 
@@ -47,14 +47,14 @@ When running the command, it will:
 Installing the [`Pinia`](/modules/pinia) module
 
 ```bash [Terminal]
-npx nuxt module add pinia
+npx nuxi module add pinia
 ```
 
-## nuxt module search
+## nuxi module search
 
 <!--module-search-cmd-->
 ```bash [Terminal]
-npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
+npx nuxi module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
 ```
 <!--/module-search-cmd-->
 
@@ -80,5 +80,5 @@ The command searches for Nuxt modules matching your query that are compatible wi
 **Example:**
 
 ```bash [Terminal]
-npx nuxt module search pinia
+npx nuxi module search pinia
 ```

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

@@ -1,5 +1,5 @@
 ---
-title: 'nuxt prepare'
+title: 'nuxi prepare'
 description: The prepare command creates a .nuxt directory in your application and generates types.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--prepare-cmd-->
 ```bash [Terminal]
-npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName]
+npx nuxi prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName]
 ```
 <!--/prepare-cmd-->
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt preview"
+title: "nuxi preview"
 description: The preview command starts a server to preview your application after the build command.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--preview-cmd-->
 ```bash [Terminal]
-npx nuxt preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [--dotenv] [-p, --port]
+npx nuxi preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [--dotenv] [-p, --port]
 ```
 <!--/preview-cmd-->
 
@@ -39,5 +39,5 @@ Option | Default | Description
 This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a `.env` file or as command-line argument.
 
 ::note
-For convenience, in preview mode, your [`.env`](/docs/guide/directory-structure/env) file will be loaded into `process.env`. (However, in production you will need to ensure your environment variables are set yourself. For example, with Node.js 20+ you could do this by running `node --env-file .env .output/server/index.mjs` to start your server.)
+For convenience, in preview mode, your [`.env`](/docs/guide/directory-structure/env) file will be loaded into `process.env`. (However, in production you will need to ensure your environment variables are set yourself.)
 ::

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt typecheck"
+title: "nuxi typecheck"
 description: The typecheck command runs vue-tsc to check types throughout your app.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--typecheck-cmd-->
 ```bash [Terminal]
-npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>]
+npx nuxi typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>]
 ```
 <!--/typecheck-cmd-->
 

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

@@ -1,5 +1,5 @@
 ---
-title: "nuxt upgrade"
+title: "nuxi upgrade"
 description: The upgrade command upgrades Nuxt to the latest version.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--upgrade-cmd-->
 ```bash [Terminal]
-npx nuxt upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly>]
+npx nuxi upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly>]
 ```
 <!--/upgrade-cmd-->
 

package/3.api/5.kit/11.nitro.md

@@ -117,7 +117,7 @@ export default defineNuxtModule({
 
 ```ts twoslash
 // @errors: 2391
-import type { NitroDevEventHandler } from 'nitropack/types'
+import type { NitroDevEventHandler } from 'nitro/types'
 // ---cut---
 function addDevServerHandler (handler: NitroDevEventHandler): void
 ```
@@ -293,53 +293,6 @@ function addPrerenderRoutes (routes: string | string[]): void
 | ----------- | ------------------------------- | -------- | ---------------------------------------------- |
 | `routes`    | `string \| string[]`{lang="ts"} | `true`   | A route or an array of routes to prerender.    |
 
-## `addServerImports`
-
-Add imports to the server. It makes your imports available in Nitro without the need to import them manually.
-
-### Usage
-
-```ts twoslash
-import { defineNuxtModule, createResolver, addServerImports } from '@nuxt/kit'
-
-export default defineNuxtModule({
-  setup(options) {
-    const names = [
-      'useStoryblok',
-      'useStoryblokApi',
-      'useStoryblokBridge',
-      'renderRichText',
-      'RichTextSchema'
-    ]
-
-    names.forEach((name) =>
-      addServerImports({ name, as: name, from: '@storyblok/vue' })
-    )
-  }
-})
-```
-
-### Type
-
-```ts
-function addServerImports (dirs: Import | Import[]): void
-```
-
-### Parameters
-
-`imports`: An object or an array of objects with the following properties:
-
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `name`             | `string`                     | `true`   | Import name to be detected.                                                                                     |
-| `from`             | `string`                     | `true`   | Module specifier to import from.                                                                                |
-| `priority`         | `number`                     | `false`  | Priority of the import; if multiple imports have the same name, the one with the highest priority will be used. |
-| `disabled`         | `boolean`                    | `false`  | If this import is disabled.                                                                                     |
-| `meta`             | `Record<string, any>`        | `false`  | Metadata of the import.                                                                                         |
-| `type`             | `boolean`                    | `false`  | If this import is a pure type import.                                                                           |
-| `typeFrom`         | `string`                     | `false`  | Use this as the `from` value when generating type declarations.                                                 |
-| `as`               | `string`                     | `false`  | Import as this name.                                                                                            |
-
 ## `addServerImportsDir`
 
 Add a directory to be scanned for auto-imports by Nitro.

package/3.api/5.kit/4.autoimports.md

@@ -34,16 +34,16 @@ import { defineNuxtModule, addImports } from "@nuxt/kit";
 export default defineNuxtModule({
   setup(options, nuxt) {
     const names = [
-      'useStoryblok',
-      'useStoryblokApi',
-      'useStoryblokBridge',
-      'renderRichText',
-      'RichTextSchema'
-    ]
+      "useStoryblok",
+      "useStoryblokApi",
+      "useStoryblokBridge",
+      "renderRichText",
+      "RichTextSchema"
+    ];
 
     names.forEach((name) =>
-      addImports({ name, as: name, from: '@storyblok/vue' })
-    )
+      addImports({ name, as: name, from: "@storyblok/vue" })
+    );
   }
 })
 ```

package/3.api/6.advanced/1.hooks.md

@@ -68,7 +68,7 @@ Hook                     | Arguments                  | Description
 `nitro:build:public-assets`     | `nitro`                    | Called after copying public assets. Allows modifying public assets before Nitro server is built.
 `prerender:routes`       | `ctx`                      | Allows extending the routes to be pre-rendered.
 `build:error`            | `error`                    | Called when an error occurs at build time.
-`prepare:types`          | `options`                  | Called before `@nuxt/cli` writes `.nuxt/tsconfig.json` and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in `tsconfig.json`
+`prepare:types`          | `options`                  | Called before Nuxi writes `.nuxt/tsconfig.json` and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in `tsconfig.json`
 `listen`                 | `listenerServer, listener` | Called when the dev server is loading.
 `schema:extend`          | `schemas`                  | Allows extending default schemas.
 `schema:resolved`        | `schema`                   | Allows extending resolved schema.