@nuxt/docs-nightly 4.3.0-29356103.2f7957ac → 4.3.0-29430576.f48ea4c8

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

@@ -1,183 +0,0 @@
----
-title: 'useCookie'
-description: useCookie is an SSR-friendly composable to read and write cookies.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/cookie.ts
-    size: xs
----
-
-## Usage
-
-Within your pages, components, and plugins, you can use `useCookie` to read and write cookies in an SSR-friendly way.
-
-```ts
-const cookie = useCookie(name, options)
-```
-
-::note
-`useCookie` only works in the [Nuxt context](/docs/4.x/guide/going-further/nuxt-app#the-nuxt-context).
-::
-
-::tip
-The returned ref will automatically serialize and deserialize cookie values to JSON.
-::
-
-## Type
-
-```ts [Signature]
-import type { Ref } from 'vue'
-import type { CookieParseOptions, CookieSerializeOptions } from 'cookie-es'
-
-export interface CookieOptions<T = any> extends Omit<CookieSerializeOptions & CookieParseOptions, 'decode' | 'encode'> {
-  decode?(value: string): T
-  encode?(value: T): string
-  default?: () => T | Ref<T>
-  watch?: boolean | 'shallow'
-  readonly?: boolean
-}
-
-export interface CookieRef<T> extends Ref<T> {}
-
-export function useCookie<T = string | null | undefined> (
-  name: string,
-  options?: CookieOptions<T>
-): CookieRef<T>
-```
-
-## Parameters
-
-`name`: The name of the cookie.
-
-`options`: Options to control cookie behavior. The object can have the following properties:
-
-Most of the options will be directly passed to the [cookie](https://github.com/jshttp/cookie) package.
-
-| Property | Type | Default | Description |
-| --- | --- | --- | --- |
-| `decode` | `(value: string) => T` | `decodeURIComponent` + [destr](https://github.com/unjs/destr). | Custom function to decode the cookie value.  Since the value of a cookie has a limited character set (and must be a simple string), this function can be used to decode a previously encoded cookie value into a JavaScript string or other object. <br/> **Note:** If an error is thrown from this function, the original, non-decoded cookie value will be returned as the cookie's value. |
-| `encode` | `(value: T) => string` | `JSON.stringify` + `encodeURIComponent` | Custom function to encode the cookie value. Since the value of a cookie has a limited character set (and must be a simple string), this function can be used to encode a value into a string suited for a cookie's value. |
-| `default` | `() => T \| Ref<T>` | `undefined` | Function returning the default value if the cookie does not exist.  The function can also return a `Ref`. |
-| `watch` | `boolean \| 'shallow'` | `true`  | Whether to watch for changes and update the cookie. `true` for deep watch, `'shallow'` for shallow watch, i.e. data changes for only top level properties, `false` to disable. <br/> **Note:** Refresh `useCookie` values manually when a cookie has changed with [`refreshCookie`](/docs/4.x/api/utils/refresh-cookie). |
-| `readonly` | `boolean` | `false` | If `true`, disables writing to the cookie. |
-| `maxAge` | `number` | `undefined` | Max age in seconds for the cookie, i.e. the value for the [`Max-Age` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.2). The given number will be converted to an integer by rounding down. By default, no maximum age is set. |
-| `expires` | `Date` | `undefined` | Expiration date for the cookie. By default, no expiration is set. Most clients will consider this a "non-persistent cookie" and will delete it on a condition like exiting a web browser application. <br/> **Note:** The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and `maxAge` is set, then `maxAge` takes precedence, but not all clients may obey this, so if both are set, they should point to the same date and time! <br/>If neither of `expires` and `maxAge` is set, the cookie will be session-only and removed when the user closes their browser. |
-| `httpOnly` | `boolean` | `false` | Sets the HttpOnly attribute. <br/> **Note:** Be careful when setting this to `true`, as compliant clients will not allow client-side JavaScript to see the cookie in `document.cookie`. |
-| `secure` | `boolean` | `false` | Sets the [`Secure` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5). <br/>**Note:** Be careful when setting this to `true`, as compliant clients will not send the cookie back to the server in the future if the browser does not have an HTTPS connection. This can lead to hydration errors. |
-| `partitioned` | `boolean` | `false` | Sets the [`Partitioned` `Set-Cookie` attribute](https://datatracker.ietf.org/doc/html/draft-cutler-httpbis-partitioned-cookies#section-2.1). <br/>**Note:** This is an attribute that has not yet been fully standardized, and may change in the future. <br/>This also means many clients may ignore this attribute until they understand it.<br/>More information can be found in the [proposal](https://github.com/privacycg/CHIPS). |
-| `domain` | `string` | `undefined` | Sets the [`Domain` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3). By default, no domain is set, and most clients will consider applying the cookie only to the current domain. |
-| `path` | `string` | `'/'` | Sets the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4). By default, the path is considered the ["default path"](https://tools.ietf.org/html/rfc6265#section-5.1.4). |
-| `sameSite` | `boolean \| string` | `undefined` | Sets the [`SameSite` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7). <br/>- `true` will set the `SameSite` attribute to `Strict` for strict same-site enforcement.<br/>- `false` will not set the `SameSite` attribute.<br/>- `'lax'` will set the `SameSite` attribute to `Lax` for lax same-site enforcement.<br/>- `'none'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.<br/>- `'strict'` will set the `SameSite` attribute to `Strict` for strict same-site enforcement. |
-
-## Return Values
-
-Returns a Vue `Ref<T>` representing the cookie value. Updating the ref will update the cookie (unless `readonly` is set). The ref is SSR-friendly and will work on both client and server.
-
-## Examples
-
-### Basic Usage
-
-The example below creates a cookie called `counter`. If the cookie doesn't exist, it is initially set to a random value. Whenever we update the `counter` variable, the cookie will be updated accordingly.
-
-```vue [app/app.vue]
-<script setup lang="ts">
-const counter = useCookie('counter')
-
-counter.value ||= Math.round(Math.random() * 1000)
-</script>
-
-<template>
-  <div>
-    <h1>Counter: {{ counter || '-' }}</h1>
-    <button @click="counter = null">
-      reset
-    </button>
-    <button @click="counter--">
-      -
-    </button>
-    <button @click="counter++">
-      +
-    </button>
-  </div>
-</template>
-```
-
-### Readonly Cookies
-
-```vue
-<script setup lang="ts">
-const user = useCookie(
-  'userInfo',
-  {
-    default: () => ({ score: -1 }),
-    watch: false,
-  },
-)
-
-if (user.value) {
-  // the actual `userInfo` cookie will not be updated
-  user.value.score++
-}
-</script>
-
-<template>
-  <div>User score: {{ user?.score }}</div>
-</template>
-```
-
-### Writable Cookies
-
-```vue
-<script setup lang="ts">
-const list = useCookie(
-  'list',
-  {
-    default: () => [],
-    watch: 'shallow',
-  },
-)
-
-function add () {
-  list.value?.push(Math.round(Math.random() * 1000))
-  // list cookie won't be updated with this change
-}
-
-function save () {
-  // the actual `list` cookie will be updated
-  list.value &&= [...list.value]
-}
-</script>
-
-<template>
-  <div>
-    <h1>List</h1>
-    <pre>{{ list }}</pre>
-    <button @click="add">
-      Add
-    </button>
-    <button @click="save">
-      Save
-    </button>
-  </div>
-</template>
-```
-
-### Cookies in API Routes
-
-You can use `getCookie` and `setCookie` from [`h3`](https://github.com/h3js/h3) package to set cookies in server API routes.
-
-```ts [server/api/counter.ts]
-export default defineEventHandler((event) => {
-  // Read counter cookie
-  let counter = getCookie(event, 'counter') || 0
-
-  // Increase counter cookie by 1
-  setCookie(event, 'counter', ++counter)
-
-  // Send JSON response
-  return { counter }
-})
-```
-
-:link-example{to="/docs/4.x/examples/advanced/use-cookie"}

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

@@ -1,69 +0,0 @@
----
-title: useHead
-description: useHead customizes the head properties of individual pages of your Nuxt app.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/unjs/unhead/blob/main/packages/vue/src/composables.ts
-    size: xs
----
-
-The [`useHead`](/docs/4.x/api/composables/use-head) composable function allows you to manage your head tags in a programmatic and reactive way, powered by [Unhead](https://unhead.unjs.io). If the data comes from a user or other untrusted source, we recommend you check out [`useHeadSafe`](/docs/4.x/api/composables/use-head-safe).
-
-:read-more{to="/docs/4.x/getting-started/seo-meta"}
-
-## Type
-
-```ts [Signature]
-export function useHead (meta: MaybeComputedRef<MetaObject>): void
-```
-
-Below are the non-reactive types for [`useHead`](/docs/4.x/api/composables/use-head) .
-
-```ts
-interface MetaObject {
-  title?: string
-  titleTemplate?: string | ((title?: string) => string)
-  base?: Base
-  link?: Link[]
-  meta?: Meta[]
-  style?: Style[]
-  script?: Script[]
-  noscript?: Noscript[]
-  htmlAttrs?: HtmlAttributes
-  bodyAttrs?: BodyAttributes
-}
-```
-
-See [@unhead/vue](https://github.com/unjs/unhead/blob/main/packages/vue/src/types/schema.ts) for more detailed types.
-
-::note
-The properties of `useHead` can be dynamic, accepting `ref`, `computed` and `reactive` properties. `meta` parameter can also accept a function returning an object to make the entire object reactive.
-::
-
-## Params
-
-### `meta`
-
-**Type**: `MetaObject`
-
-An object accepting the following head metadata:
-
-- `meta`: Each element in the array is mapped to a newly-created `<meta>` tag, where object properties are mapped to the corresponding attributes.
-  - **Type**: `Array<Record<string, any>>`
-- `link`: Each element in the array is mapped to a newly-created `<link>` tag, where object properties are mapped to the corresponding attributes.
-  - **Type**: `Array<Record<string, any>>`
-- `style`: Each element in the array is mapped to a newly-created `<style>` tag, where object properties are mapped to the corresponding attributes.
-  - **Type**: `Array<Record<string, any>>`
-- `script`: Each element in the array is mapped to a newly-created `<script>` tag, where object properties are mapped to the corresponding attributes.
-  - **Type**: `Array<Record<string, any>>`
-- `noscript`: Each element in the array is mapped to a newly-created `<noscript>` tag, where object properties are mapped to the corresponding attributes.
-  - **Type**: `Array<Record<string, any>>`
-- `titleTemplate`: Configures dynamic template to customize the page title on an individual page.
-  - **Type**: `string` | `((title: string) => string)`
-- `title`: Sets static page title on an individual page.
-  - **Type**: `string`
-- `bodyAttrs`: Sets attributes of the `<body>` tag. Each object property is mapped to the corresponding attribute.
-  - **Type**: `Record<string, any>`
-- `htmlAttrs`: Sets attributes of the `<html>` tag. Each object property is mapped to the corresponding attribute.
-  - **Type**: `Record<string, any>`

package/3.api/2.composables/use-lazy-async-data.md

@@ -1,47 +0,0 @@
----
-title: useLazyAsyncData
-description: This wrapper around useAsyncData triggers navigation immediately.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/asyncData.ts
-    size: xs
----
-
-## Description
-
-By default, [`useAsyncData`](/docs/4.x/api/composables/use-async-data) blocks navigation until its async handler is resolved. `useLazyAsyncData` provides a wrapper around [`useAsyncData`](/docs/4.x/api/composables/use-async-data) that triggers navigation before the handler is resolved by setting the `lazy` option to `true`.
-
-::note
-`useLazyAsyncData` has the same signature as [`useAsyncData`](/docs/4.x/api/composables/use-async-data).
-::
-
-:read-more{to="/docs/4.x/api/composables/use-async-data"}
-
-## Example
-
-```vue [app/pages/index.vue]
-<script setup lang="ts">
-/* Navigation will occur before fetching is complete.
-  Handle 'pending' and 'error' states directly within your component's template
-*/
-const { status, data: count } = await useLazyAsyncData('count', () => $fetch('/api/count'))
-
-watch(count, (newCount) => {
-  // Because count might start out null, you won't have access
-  // to its contents immediately, but you can watch it.
-})
-</script>
-
-<template>
-  <div>
-    {{ status === 'pending' ? 'Loading' : count }}
-  </div>
-</template>
-```
-
-::warning
-`useLazyAsyncData` is a reserved function name transformed by the compiler, so you should not name your own function `useLazyAsyncData`.
-::
-
-:read-more{to="/docs/4.x/getting-started/data-fetching"}

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

@@ -1,55 +0,0 @@
----
-title: 'useLazyFetch'
-description: This wrapper around useFetch triggers navigation immediately.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/fetch.ts
-    size: xs
----
-
-## Description
-
-By default, [`useFetch`](/docs/4.x/api/composables/use-fetch) blocks navigation until its async handler is resolved. `useLazyFetch` provides a wrapper around [`useFetch`](/docs/4.x/api/composables/use-fetch) that triggers navigation before the handler is resolved by setting the `lazy` option to `true`.
-
-::note
-`useLazyFetch` has the same signature as [`useFetch`](/docs/4.x/api/composables/use-fetch).
-::
-
-::note
-Awaiting `useLazyFetch` in this mode only ensures the call is initialized. On client-side navigation, data may not be immediately available, and you should make sure to handle the pending state in your app.
-::
-
-:read-more{to="/docs/4.x/api/composables/use-fetch"}
-
-## Example
-
-```vue [app/pages/index.vue]
-<script setup lang="ts">
-/* Navigation will occur before fetching is complete.
- * Handle 'pending' and 'error' states directly within your component's template
- */
-const { status, data: posts } = await useLazyFetch('/api/posts')
-watch(posts, (newPosts) => {
-  // Because posts might start out null, you won't have access
-  // to its contents immediately, but you can watch it.
-})
-</script>
-
-<template>
-  <div v-if="status === 'pending'">
-    Loading ...
-  </div>
-  <div v-else>
-    <div v-for="post in posts">
-      <!-- do something -->
-    </div>
-  </div>
-</template>
-```
-
-::note
-`useLazyFetch` is a reserved function name transformed by the compiler, so you should not name your own function `useLazyFetch`.
-::
-
-:read-more{to="/docs/4.x/getting-started/data-fetching"}

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

@@ -1,94 +0,0 @@
----
-title: "useRouter"
-description: "The useRouter composable returns the router instance."
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/router.ts
-    size: xs
----
-
-```vue [app/pages/index.vue]
-<script setup lang="ts">
-const router = useRouter()
-</script>
-```
-
-If you only need the router instance within your template, use `$router`:
-
-```vue [app/pages/index.vue]
-<template>
-  <button @click="$router.back()">
-    Back
-  </button>
-</template>
-```
-
-If you have a `app/pages/` directory, `useRouter` is identical in behavior to the one provided by `vue-router`.
-
-::read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/Router.html#Properties-currentRoute" target="_blank"}
-Read `vue-router` documentation about the `Router` interface.
-::
-
-## Basic Manipulation
-
-- [`addRoute()`](https://router.vuejs.org/api/interfaces/Router.html#addRoute): Add a new route to the router instance. `parentName` can be provided to add new route as the child of an existing route.
-- [`removeRoute()`](https://router.vuejs.org/api/interfaces/Router.html#removeRoute): Remove an existing route by its name.
-- [`getRoutes()`](https://router.vuejs.org/api/interfaces/Router.html#getRoutes): Get a full list of all the route records.
-- [`hasRoute()`](https://router.vuejs.org/api/interfaces/Router.html#hasRoute): Checks if a route with a given name exists.
-- [`resolve()`](https://router.vuejs.org/api/interfaces/Router.html#resolve): Returns the normalized version of a route location. Also includes an `href` property that includes any existing base.
-
-```ts [Example]
-const router = useRouter()
-
-router.addRoute({ name: 'home', path: '/home', component: Home })
-router.removeRoute('home')
-router.getRoutes()
-router.hasRoute('home')
-router.resolve({ name: 'home' })
-```
-
-::note
-`router.addRoute()` adds route details into an array of routes and it is useful while building [Nuxt plugins](/docs/4.x/guide/directory-structure/plugins) while `router.push()` on the other hand, triggers a new navigation immediately and it is useful in pages, Vue components and composable.
-::
-
-## Based on History API
-
-- [`back()`](https://router.vuejs.org/api/interfaces/Router.html#back): Go back in history if possible, same as `router.go(-1)`.
-- [`forward()`](https://router.vuejs.org/api/interfaces/Router.html#forward): Go forward in history if possible, same as `router.go(1)`.
-- [`go()`](https://router.vuejs.org/api/interfaces/Router.html#go): Move forward or backward through the history without the hierarchical restrictions enforced in `router.back()` and `router.forward()`.
-- [`push()`](https://router.vuejs.org/api/interfaces/Router.html#push): Programmatically navigate to a new URL by pushing an entry in the history stack. **It is recommended to use [`navigateTo`](/docs/4.x/api/utils/navigate-to) instead.**
-- [`replace()`](https://router.vuejs.org/api/interfaces/Router.html#replace): Programmatically navigate to a new URL by replacing the current entry in the routes history stack. **It is recommended to use [`navigateTo`](/docs/4.x/api/utils/navigate-to) instead.**
-
-```ts [Example]
-const router = useRouter()
-
-router.back()
-router.forward()
-router.go(3)
-router.push({ path: '/home' })
-router.replace({ hash: '#bio' })
-```
-
-::read-more{icon="i-simple-icons-mdnwebdocs" to="https://developer.mozilla.org/en-US/docs/Web/API/History" target="_blank"}
-Read more about the browser's History API.
-::
-
-## Navigation Guards
-
-`useRouter` composable provides `afterEach`, `beforeEach` and `beforeResolve` helper methods that acts as navigation guards.
-
-However, Nuxt has a concept of **route middleware** that simplifies the implementation of navigation guards and provides a better developer experience.
-
-:read-more{to="/docs/4.x/guide/directory-structure/app/middleware"}
-
-## Promise and Error Handling
-
-- [`isReady()`](https://router.vuejs.org/api/interfaces/Router.html#isReady): Returns a Promise that resolves when the router has completed the initial navigation.
-- [`onError`](https://router.vuejs.org/api/interfaces/Router.html#onError): Adds an error handler that is called every time a non caught error happens during navigation.
-
-:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/Router.html#Methods" title="Vue Router Docs" target="_blank"}
-
-## Universal Router Instance
-
-If you do not have a `app/pages/` folder, then [`useRouter`](/docs/4.x/api/composables/use-router)  will return a universal router instance with similar helper methods, but be aware that not all features may be supported or behave in exactly the same way as with `vue-router`.

package/3.api/3.utils/define-nuxt-plugin.md

@@ -1,102 +0,0 @@
----
-title: "defineNuxtPlugin"
-description: defineNuxtPlugin() is a helper function for creating Nuxt plugins.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts
-    size: xs
----
-
-`defineNuxtPlugin` is a helper function for creating Nuxt plugins with enhanced functionality and type safety. This utility normalizes different plugin formats into a consistent structure that works seamlessly within Nuxt's plugin system.
-
-```ts twoslash [plugins/hello.ts]
-export default defineNuxtPlugin((nuxtApp) => {
-  // Doing something with nuxtApp
-})
-```
-
-:read-more{to="/docs/4.x/guide/directory-structure/app/plugins#creating-plugins"}
-
-## Type
-
-```ts [Signature]
-export function defineNuxtPlugin<T extends Record<string, unknown>> (plugin: Plugin<T> | ObjectPlugin<T>): Plugin<T> & ObjectPlugin<T>
-
-type Plugin<T> = (nuxt: NuxtApp) => Promise<void> | Promise<{ provide?: T }> | void | { provide?: T }
-
-interface ObjectPlugin<T> {
-  name?: string
-  enforce?: 'pre' | 'default' | 'post'
-  dependsOn?: string[]
-  order?: number
-  parallel?: boolean
-  setup?: Plugin<T>
-  hooks?: Partial<RuntimeNuxtHooks>
-  env?: {
-    islands?: boolean
-  }
-}
-```
-
-## Parameters
-
-**plugin**: A plugin can be defined in two ways:
-1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with an potential object with a [`provide`](/docs/4.x/guide/directory-structure/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance.
-2. **Object Plugin**: An object that can include various properties to configure the plugin's behavior, such as `name`, `enforce`, `dependsOn`, `order`, `parallel`, `setup`, `hooks`, and `env`.
-
-| Property           | Type                                                                 | Required | Description                                                                                                     |
-| ------------------ | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `name` | `string` | `false` | Optional name for the plugin, useful for debugging and dependency management. |
-| `enforce` | `'pre'` \| `'default'` \| `'post'` | `false` | Controls when the plugin runs relative to other plugins. |
-| `dependsOn` | `string[]` | `false` | Array of plugin names this plugin depends on. Ensures proper execution order. |
-| `order` | `number` | `false` | This allows more granular control over plugin order and should only be used by advanced users. **It overrides the value of `enforce` and is used to sort plugins.** |
-| `parallel` | `boolean` | `false` | Whether to execute the plugin in parallel with other parallel plugins. |
-| `setup` | `Plugin<T>`{lang="ts"}  | `false` | The main plugin function, equivalent to a function plugin. |
-| `hooks` | `Partial<RuntimeNuxtHooks>`{lang="ts"}  | `false` | Nuxt app runtime hooks to register directly. |
-| `env` | `{ islands?: boolean }`{lang="ts"}  | `false` | Set this value to `false` if you don't want the plugin to run when rendering server-only or island components. |
-
-:video-accordion{title="Watch a video from Alexander Lichter about the Object Syntax for Nuxt plugins" videoId="2aXZyXB1QGQ"}
-
-## Examples
-
-### Basic Usage
-
-The example below demonstrates a simple plugin that adds global functionality:
-
-```ts twoslash [plugins/hello.ts]
-export default defineNuxtPlugin((nuxtApp) => {
-  // Add a global method
-  return {
-    provide: {
-      hello: (name: string) => `Hello ${name}!`,
-    },
-  }
-})
-```
-
-### Object Syntax Plugin
-
-The example below shows the object syntax with advanced configuration:
-
-```ts twoslash [plugins/advanced.ts]
-export default defineNuxtPlugin({
-  name: 'my-plugin',
-  enforce: 'pre',
-  async setup (nuxtApp) {
-    // Plugin setup logic
-    const data = await $fetch('/api/config')
-
-    return {
-      provide: {
-        config: data,
-      },
-    }
-  },
-  hooks: {
-    'app:created' () {
-      console.log('App created!')
-    },
-  },
-})
-```

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

@@ -1,42 +0,0 @@
----
-title: "nuxt analyze"
-description: "Analyze the production bundle or your Nuxt application."
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/analyze.ts
-    size: xs
----
-
-<!--analyze-cmd-->
-```bash [Terminal]
-npx nuxt analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [-e, --extends=<layer-name>] [--name=<name>] [--no-serve]
-```
-<!--/analyze-cmd-->
-
-The `analyze` command builds Nuxt and analyzes the production bundle (experimental).
-
-## Arguments
-
-<!--analyze-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/analyze-args-->
-
-## Options
-
-<!--analyze-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--dotenv` |  | Path to `.env` file to load, relative to the root directory
-`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
-`--name=<name>` | `default` | Name of the analysis
-`--no-serve` |  | Skip serving the analysis results
-<!--/analyze-opts-->
-
-::note
-This command sets `process.env.NODE_ENV` to `production`.
-::

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

@@ -1,42 +0,0 @@
----
-title: 'nuxt build-module'
-description: 'Nuxt command to build your Nuxt module before publishing.'
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/module-builder/blob/main/src/cli.ts
-    size: xs
----
-
-<!--build-module-cmd-->
-```bash [Terminal]
-npx nuxt build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
-```
-<!--/build-module-cmd-->
-
-The `build-module` command runs `@nuxt/module-builder` to generate `dist` directory within your `rootDir` that contains the full build for your **nuxt-module**.
-
-## Arguments
-
-<!--build-module-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/build-module-args-->
-
-## Options
-
-<!--build-module-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--build` | `false` | Build module for distribution
-`--stub` | `false` | Stub dist instead of actually building it for development
-`--sourcemap` | `false` | Generate sourcemaps
-`--prepare` | `false` | Prepare module for local development
-<!--/build-module-opts-->
-
-::read-more{to="https://github.com/nuxt/module-builder" icon="i-simple-icons-github" target="\_blank"}
-Read more about `@nuxt/module-builder`.
-::