@nuxt/docs 4.2.1 → 4.3.0

package/4.api/4.commands/test.md

@@ -0,0 +1,40 @@
+---
+title: "nuxt test"
+description: The test command runs tests using @nuxt/test-utils.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/test.ts
+    size: xs
+---
+
+<!--test-cmd-->
+```bash [Terminal]
+npx nuxt test [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dev] [--watch]
+```
+<!--/test-cmd-->
+
+The `test` command runs tests using [`@nuxt/test-utils`](/docs/getting-started/testing). This command sets `process.env.NODE_ENV` to `test` if not already set.
+
+## Arguments
+
+<!--test-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/test-args-->
+
+## Options
+
+<!--test-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                                                     |
+| `--dev`                              |         | Run in dev mode                                                                  |
+| `--watch`                            |         | Watch mode                                                                       |
+<!--/test-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `test`.
+::

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

@@ -0,0 +1,44 @@
+---
+title: "nuxt typecheck"
+description: The typecheck command runs vue-tsc to check types throughout your app.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/typecheck.ts
+    size: xs
+---
+
+<!--typecheck-cmd-->
+```bash [Terminal]
+npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [-e, --extends=<layer-name>]
+```
+<!--/typecheck-cmd-->
+
+The `typecheck` command runs [`vue-tsc`](https://github.com/vuejs/language-tools/tree/master/packages/tsc) to check types throughout your app.
+
+## Arguments
+
+<!--typecheck-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/typecheck-args-->
+
+## Options
+
+<!--typecheck-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                                                         |
+<!--/typecheck-opts-->
+
+::note
+This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a [`.env`](/docs/4.x/directory-structure/env) file or as a command-line argument.
+::
+
+::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/4.api/4.commands/upgrade.md

@@ -0,0 +1,37 @@
+---
+title: "nuxt upgrade"
+description: The upgrade command upgrades Nuxt to the latest version.
+links:
+  - label: Source
+    icon: i-simple-icons-github
+    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/upgrade.ts
+    size: xs
+---
+
+<!--upgrade-cmd-->
+```bash [Terminal]
+npx nuxt upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly|v3|v4|v4-nightly|v3-nightly>]
+```
+<!--/upgrade-cmd-->
+
+The `upgrade` command upgrades Nuxt to the latest version.
+
+## Arguments
+
+<!--upgrade-args-->
+| Argument      | Description                                    |
+|---------------|------------------------------------------------|
+| `ROOTDIR="."` | Specifies the working directory (default: `.`) |
+<!--/upgrade-args-->
+
+## Options
+
+<!--upgrade-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                                                     |
+| `--dedupe`                                                         |          | Dedupe dependencies after upgrading                                              |
+| `-f, --force`                                                      |          | Force upgrade to recreate lockfile and node_modules                              |
+| `-ch, --channel=<stable\|nightly\|v3\|v4\|v4-nightly\|v3-nightly>` | `stable` | Specify a channel to install from (default: stable)                              |
+<!--/upgrade-opts-->

package/{3.api → 4.api}/5.kit/1.modules.md

@@ -4,7 +4,7 @@ description: Nuxt Kit provides a set of utilities to help you create and use mod
 links:
   - label: Source
     icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/kit/src/module
+    to: https://github.com/nuxt/nuxt/tree/main/packages/kit/src/module
     size: xs
 ---
 
@@ -56,16 +56,16 @@ export function defineNuxtModule<TOptions extends ModuleOptions> (): {
 
 **definition**: A module definition object or a module function. The module definition object should contain the following properties:
 
-| Property           | Type                                                                 | Required | Description                                                                                                     |
-| ------------------ | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `meta`             | `ModuleMeta`                                                         | `false`  | Metadata of the module. It defines the module name, version, config key and compatibility.                      |
-| `defaults`         | `T \| ((nuxt: Nuxt) => T)`{lang="ts"}                                | `false`  | Default options for the module. If a function is provided, it will be called with the Nuxt instance as the first argument. |
-| `schema`           | `T`                                                                  | `false`  | Schema for the module options. If provided, options will be applied to the schema.                              |
-| `hooks`            | `Partial<NuxtHooks>`{lang="ts"}                                      | `false`  | Hooks to be installed for the module. If provided, the module will install the hooks.                           |
-| `moduleDependencies` | `Record<string, ModuleDependency> \| ((nuxt: Nuxt) => Record<string, ModuleDependency>)`{lang="ts"} | `false`  | Dependencies on other modules with version constraints and configuration. Can be an object or a function that receives the Nuxt instance. See [example](/docs/4.x/api/kit/modules#specifying-module-dependencies). |
-| `onInstall`        | `(nuxt: Nuxt) => Awaitable<void>`{lang="ts"}                        | `false`  | Lifecycle hook called when the module is first installed. Requires `meta.name` and `meta.version` to be defined. |
-| `onUpgrade`        | `(options: T, nuxt: Nuxt, previousVersion: string) => Awaitable<void>`{lang="ts"} | `false`  | Lifecycle hook called when the module is upgraded to a newer version. Requires `meta.name` and `meta.version` to be defined. |
-| `setup`            | `(this: void, resolvedOptions: T, nuxt: Nuxt) => Awaitable<void \| false \| ModuleSetupInstallResult>`{lang="ts"} | `false`  | Setup function for the module. If provided, the module will call the setup function.    |
+| Property             | Type                                                                                                              | Required | Description                                                                                                                                                                                                        |
+|----------------------|-------------------------------------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `meta`               | `ModuleMeta`                                                                                                      | `false`  | Metadata of the module. It defines the module name, version, config key and compatibility.                                                                                                                         |
+| `defaults`           | `T \| ((nuxt: Nuxt) => T)`{lang="ts"}                                                                             | `false`  | Default options for the module. If a function is provided, it will be called with the Nuxt instance as the first argument.                                                                                         |
+| `schema`             | `T`                                                                                                               | `false`  | Schema for the module options. If provided, options will be applied to the schema.                                                                                                                                 |
+| `hooks`              | `Partial<NuxtHooks>`{lang="ts"}                                                                                   | `false`  | Hooks to be installed for the module. If provided, the module will install the hooks.                                                                                                                              |
+| `moduleDependencies` | `Record<string, ModuleDependency> \| ((nuxt: Nuxt) => Record<string, ModuleDependency>)`{lang="ts"}               | `false`  | Dependencies on other modules with version constraints and configuration. Can be an object or a function that receives the Nuxt instance. See [example](/docs/4.x/api/kit/modules#specifying-module-dependencies). |
+| `onInstall`          | `(nuxt: Nuxt) => Awaitable<void>`{lang="ts"}                                                                      | `false`  | Lifecycle hook called when the module is first installed. Requires `meta.name` and `meta.version` to be defined.                                                                                                   |
+| `onUpgrade`          | `(nuxt: Nuxt, options: T, previousVersion: string) => Awaitable<void>`{lang="ts"}                                 | `false`  | Lifecycle hook called when the module is upgraded to a newer version. Requires `meta.name` and `meta.version` to be defined.                                                                                       |
+| `setup`              | `(this: void, resolvedOptions: T, nuxt: Nuxt) => Awaitable<void \| false \| ModuleSetupInstallResult>`{lang="ts"} | `false`  | Setup function for the module. If provided, the module will call the setup function.                                                                                                                               |
 
 ### Examples
 
@@ -103,6 +103,19 @@ export default defineNuxtConfig({
 })
 ```
 
+Users can also completely disable a module by setting the config key to `false`. This prevents the module's setup function from running while still generating types for module options.
+
+```ts
+export default defineNuxtConfig({
+  // Disable the module entirely
+  myModule: false,
+})
+```
+
+::tip
+This is particularly useful when you want to disable modules inherited from [Nuxt layers](/docs/4.x/guide/going-further/layers#disabling-modules-from-layers).
+::
+
 #### Defining Module Compatibility Requirements
 
 If you're developing a Nuxt module and using APIs that are only supported in specific Nuxt versions, it's highly recommended to include `compatibility.nuxt`.
@@ -216,7 +229,7 @@ export default defineNuxtModule({
     // - Perform initial data migration
   },
 
-  onUpgrade (options, nuxt, previousVersion) {
+  onUpgrade (nuxt, options, previousVersion) {
     // This runs when the module is upgraded to a newer version
     console.log(`Upgrading my-awesome-module from ${previousVersion} to 1.2.0`)
 
@@ -359,11 +372,11 @@ async function installModule (moduleToInstall: string | NuxtModule, inlineOption
 
 ### Parameters
 
-| Property           | Type                                         | Required | Description                                                                                                     |
-| ------------------ | -------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `moduleToInstall`  | `string \| NuxtModule`{lang="ts"}            | `true`   | The module to install. Can be either a string with the module name or a module object itself.                   |
-| `inlineOptions`    | `any`                                        | `false`  | An object with the module options to be passed to the module's `setup` function.                                |
-| `nuxt`             | `Nuxt`                                       | `false`  | Nuxt instance. If not provided, it will be retrieved from the context via `useNuxt()` call.                     |
+| Property          | Type                              | Required | Description                                                                                   |
+|-------------------|-----------------------------------|----------|-----------------------------------------------------------------------------------------------|
+| `moduleToInstall` | `string \| NuxtModule`{lang="ts"} | `true`   | The module to install. Can be either a string with the module name or a module object itself. |
+| `inlineOptions`   | `any`                             | `false`  | An object with the module options to be passed to the module's `setup` function.              |
+| `nuxt`            | `Nuxt`                            | `false`  | Nuxt instance. If not provided, it will be retrieved from the context via `useNuxt()` call.   |
 
 ### Examples
 

package/{3.api → 4.api}/5.kit/10.templates.md

@@ -48,14 +48,14 @@ function addTemplate (template: NuxtTemplate | string): ResolvedNuxtTemplate
 
 **template**: A template object or a string with the path to the template. If a string is provided, it will be converted to a template object with `src` set to the string value. If a template object is provided, it must have the following properties:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `src`      | `string`                                                             | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                         |
-| `filename` | `string`                                                             | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required. |
-| `dst`      | `string`                                                             | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option. |
-| `options`  | `Options`                                                           | `false`  | Options to pass to the template.                                                                                |
+| Property      | Type                                                      | Required | Description                                                                                                                                                                      |
+|---------------|-----------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `src`         | `string`                                                  | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                                                                                          |
+| `filename`    | `string`                                                  | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required.                                   |
+| `dst`         | `string`                                                  | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option.                                                |
+| `options`     | `Options`                                                 | `false`  | Options to pass to the template.                                                                                                                                                 |
 | `getContents` | `(data: Options) => string \| Promise<string>`{lang="ts"} | `false`  | A function that will be called with the `options` object. It should return a string or a promise that resolves to a string. If `src` is provided, this function will be ignored. |
-| `write`    | `boolean`                                                            | `false`  | If set to `true`, the template will be written to the destination file. Otherwise, the template will be used only in virtual filesystem. |
+| `write`       | `boolean`                                                 | `false`  | If set to `true`, the template will be written to the destination file. Otherwise, the template will be used only in virtual filesystem.                                         |
 
 ### Examples
 
@@ -133,20 +133,20 @@ function addTypeTemplate (template: NuxtTypeTemplate | string, context?: { nitro
 
 **template**: A template object or a string with the path to the template. If a string is provided, it will be converted to a template object with `src` set to the string value. If a template object is provided, it must have the following properties:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `src`      | `string`                                                             | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                         |
-| `filename` | `string`                                                             | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required. |
-| `dst`      | `string`                                                             | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option. |
-| `options`  | `Options`                                                            | `false`  | Options to pass to the template.                                                                                |
+| Property      | Type                                                      | Required | Description                                                                                                                                                                      |
+|---------------|-----------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `src`         | `string`                                                  | `false`  | Path to the template. If `src` is not provided, `getContents` must be provided instead.                                                                                          |
+| `filename`    | `string`                                                  | `false`  | Filename of the template. If `filename` is not provided, it will be generated from the `src` path. In this case, the `src` option is required.                                   |
+| `dst`         | `string`                                                  | `false`  | Path to the destination file. If `dst` is not provided, it will be generated from the `filename` path and nuxt `buildDir` option.                                                |
+| `options`     | `Options`                                                 | `false`  | Options to pass to the template.                                                                                                                                                 |
 | `getContents` | `(data: Options) => string \| Promise<string>`{lang="ts"} | `false`  | A function that will be called with the `options` object. It should return a string or a promise that resolves to a string. If `src` is provided, this function will be ignored. |
 
 **context**: An optional context object can be passed to control where the type is added. If omitted, the type will only be added to the Nuxt context. This object supports the following properties:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `nuxt`     | `boolean`                                                            | `false`  | If set to `true`, the type will be added to the Nuxt context.                                                   |
-| `nitro`    | `boolean`                                                            | `false`  | If set to `true`, the type will be added to the Nitro context.                                                  |
+| Property | Type      | Required | Description                                                    |
+|----------|-----------|----------|----------------------------------------------------------------|
+| `nuxt`   | `boolean` | `false`  | If set to `true`, the type will be added to the Nuxt context.  |
+| `nitro`  | `boolean` | `false`  | If set to `true`, the type will be added to the Nitro context. |
 
 ### Examples
 
@@ -226,9 +226,9 @@ function addServerTemplate (template: NuxtServerTemplate): NuxtServerTemplate
 
 **template**: A template object. It must have the following properties:
 
-| Property      | Type                                         | Required | Description                                                                                                     |
-| ------------- | ---------------------------------------------| -------- | --------------------------------------------------------------------------------------------------------------- |
-| `filename`    | `string`                                     | `true`   | Filename of the template.                                                                                       |
+| Property      | Type                                         | Required | Description                                                                                                                 |
+|---------------|----------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
+| `filename`    | `string`                                     | `true`   | Filename of the template.                                                                                                   |
 | `getContents` | `() => string \| Promise<string>`{lang="ts"} | `true`   | A function that will be called with the `options` object. It should return a string or a promise that resolves to a string. |
 
 ### Examples
@@ -304,6 +304,6 @@ async function updateTemplates (options: UpdateTemplatesOptions): void
 
 **options**: Options to pass to the template. This object can have the following property:
 
-| Property   | Type                                                                 | Required | Description                                                                                                     |
-| ---------- | -------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `filter`    | `(template: ResolvedNuxtTemplate) => boolean`{lang="ts"} | `false`  | A function that will be called with the `template` object. It should return a boolean indicating whether the template should be regenerated. If `filter` is not provided, all templates will be regenerated. |
+| Property | Type                                                     | Required | Description                                                                                                                                                                                                  |
+|----------|----------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `filter` | `(template: ResolvedNuxtTemplate) => boolean`{lang="ts"} | `false`  | A function that will be called with the `template` object. It should return a boolean indicating whether the template should be regenerated. If `filter` is not provided, all templates will be regenerated. |

package/{3.api → 4.api}/5.kit/11.nitro.md

@@ -41,13 +41,13 @@ function addServerHandler (handler: NitroEventHandler): void
 
 **handler**: A handler object with the following properties:
 
-| Property    | Type            | Required | Description                                                                                                     |
-| ----------- | --------------  | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `handler`   | `string`        | `true`   | Path to event handler.                                                                                          |
-| `route`     | `string`        | `false`  | Path prefix or route. If an empty string used, will be used as a middleware.                                    |
-| `middleware`| `boolean`       | `false`  | Specifies this is a middleware handler. Middleware are called on every route and should normally return nothing to pass to the next handlers. |
-| `lazy`      | `boolean`       | `false`  | Use lazy loading to import the handler. This is useful when you only want to load the handler on demand.        |
-| `method`    | `string`        | `false`  | Router method matcher. If handler name contains method name, it will be used as a default value.                |
+| Property     | Type      | Required | Description                                                                                                                                   |
+|--------------|-----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| `handler`    | `string`  | `true`   | Path to event handler.                                                                                                                        |
+| `route`      | `string`  | `false`  | Path prefix or route. If an empty string used, will be used as a middleware.                                                                  |
+| `middleware` | `boolean` | `false`  | Specifies this is a middleware handler. Middleware are called on every route and should normally return nothing to pass to the next handlers. |
+| `lazy`       | `boolean` | `false`  | Use lazy loading to import the handler. This is useful when you only want to load the handler on demand.                                      |
+| `method`     | `string`  | `false`  | Router method matcher. If handler name contains method name, it will be used as a default value.                                              |
 
 ### Examples
 
@@ -126,10 +126,10 @@ function addDevServerHandler (handler: NitroDevEventHandler): void
 
 **handler**: A handler object with the following properties:
 
-| Property    | Type            | Required | Description                                                                                                     |
-| ----------- | --------------  | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `handler`   | `EventHandler`  | `true`   | Event handler.                                                                                                  |
-| `route`     | `string`        | `false`  | Path prefix or route. If an empty string used, will be used as a middleware.                                    |
+| Property  | Type           | Required | Description                                                                  |
+|-----------|----------------|----------|------------------------------------------------------------------------------|
+| `handler` | `EventHandler` | `true`   | Event handler.                                                               |
+| `route`   | `string`       | `false`  | Path prefix or route. If an empty string used, will be used as a middleware. |
 
 ### Examples
 
@@ -222,9 +222,9 @@ function addServerPlugin (plugin: string): void
 
 ### Parameters
 
-| Property    | Type            | Required | Description                                                                                                     |
-| ----------- | --------------  | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `plugin`    | `string`        | `true`   | Path to the plugin. The plugin must export a default function that accepts the Nitro instance as an argument.   |
+| Property | Type     | Required | Description                                                                                                   |
+|----------|----------|----------|---------------------------------------------------------------------------------------------------------------|
+| `plugin` | `string` | `true`   | Path to the plugin. The plugin must export a default function that accepts the Nitro instance as an argument. |
 
 ### Examples
 
@@ -293,9 +293,9 @@ function addPrerenderRoutes (routes: string | string[]): void
 
 ### Parameters
 
-| Property    | Type                            | Required | Description                                    |
-| ----------- | ------------------------------- | -------- | ---------------------------------------------- |
-| `routes`    | `string \| string[]`{lang="ts"} | `true`   | A route or an array of routes to prerender.    |
+| Property | Type                            | Required | Description                                 |
+|----------|---------------------------------|----------|---------------------------------------------|
+| `routes` | `string \| string[]`{lang="ts"} | `true`   | A route or an array of routes to prerender. |
 
 ## `addServerImports`
 
@@ -333,16 +333,16 @@ function addServerImports (dirs: Import | Import[]): void
 
 `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.                                                                                            |
+| 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`
 
@@ -373,10 +373,10 @@ function addServerImportsDir (dirs: string | string[], opts: { prepend?: boolean
 
 ### Parameters
 
-| Property    | Type                            | Required | Description                                    |
-| ----------- | ------------------------------- | -------- | ---------------------------------------------- |
-| `dirs`      | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned by Nitro. |
-| `opts`      | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
+| Property | Type                            | Required | Description                                                                                                         |
+|----------|---------------------------------|----------|---------------------------------------------------------------------------------------------------------------------|
+| `dirs`   | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned by Nitro.                                          |
+| `opts`   | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
 
 ### Examples
 
@@ -453,10 +453,10 @@ function addServerScanDir (dirs: string | string[], opts: { prepend?: boolean })
 
 ### Parameters
 
-| Property    | Type                            | Required | Description                                    |
-| ----------- | ------------------------------- | -------- | ---------------------------------------------- |
-| `dirs`      | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned for by Nitro as server dirs. |
-| `opts`      | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
+| Property | Type                            | Required | Description                                                                                                         |
+|----------|---------------------------------|----------|---------------------------------------------------------------------------------------------------------------------|
+| `dirs`   | `string \| string[]`{lang="ts"} | `true`   | A directory or an array of directories to register to be scanned for by Nitro as server dirs.                       |
+| `opts`   | `{ prepend?: boolean }`         | `false`  | Options for the import directory. If `prepend` is `true`, the directory is added to the beginning of the scan list. |
 
 ### Examples
 

package/{3.api → 4.api}/5.kit/14.builder.md

@@ -93,13 +93,13 @@ Check out the Vite website for more information about its configuration.
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
-| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
+| Property  | Type      | Required | Description                                                                                                                                                                   |
+|-----------|-----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                                                                                     |
+| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                                                                                      |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle. **Deprecated in Nuxt 5+.** Use `addVitePlugin()` with `applyToEnvironment()` instead. |
 | `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle. **Deprecated in Nuxt 5+.** Use `addVitePlugin()` with `applyToEnvironment()` instead. |
-| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`. |
+| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`.                                                                  |
 
 ## `extendWebpackConfig`
 
@@ -143,7 +143,7 @@ Check out webpack website for more information about its configuration.
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
 | Property  | Type      | Required | Description                                                                                                  |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------|
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |
@@ -207,17 +207,29 @@ See [Vite website](https://vite.dev/guide/api-plugin) for more information about
 
 ### Parameters
 
-**`pluginOrGetter`**: A Vite plugin instance or an array of Vite plugin instances. If a function is provided, it must return a Vite plugin instance or an array of Vite plugin instances.
+**`pluginOrGetter`**: A Vite plugin instance or an array of Vite plugin instances. If a function is provided, it must return a Vite plugin instance or an array of Vite plugin instances. The function can also be async or return a Promise, which is useful for lazy-loading plugins:
+
+```ts twoslash
+// @errors: 2307
+import { addVitePlugin, defineNuxtModule } from '@nuxt/kit'
+
+export default defineNuxtModule({
+  setup () {
+    // Lazy load the plugin - only imported when the build actually runs
+    addVitePlugin(() => import('my-vite-plugin').then(r => r.default()))
+  },
+})
+```
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
-| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
+| Property  | Type      | Required | Description                                                                                                                                            |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                                                              |
+| `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                                                               |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle. **Deprecated in Nuxt 5+.** Use `applyToEnvironment()` instead. |
 | `client`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the client bundle. **Deprecated in Nuxt 5+.** Use `applyToEnvironment()` instead. |
-| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`. |
+| `prepend` | `boolean` | `false`  | If set to `true`, the callback function will be prepended to the array with `unshift()` instead of `push()`.                                           |
 
 ## `addWebpackPlugin`
 
@@ -266,12 +278,12 @@ See [webpack website](https://webpack.js.org/concepts/plugins/) for more informa
 
 ### Parameters
 
-**`pluginOrGetter`**: A webpack plugin instance or an array of webpack plugin instances. If a function is provided, it must return a webpack plugin instance or an array of webpack plugin instances.
+**`pluginOrGetter`**: A webpack plugin instance or an array of webpack plugin instances. If a function is provided, it must return a webpack plugin instance or an array of webpack plugin instances. The function can also be async or return a Promise, enabling lazy-loading of plugins.
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
+| Property  | Type      | Required | Description                                                                                                  |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------|
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |
@@ -306,8 +318,8 @@ function addBuildPlugin (pluginFactory: AddBuildPluginFactory, options?: ExtendC
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
-| Property  | Type      | Required | Description                                                                                                 |
-| --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
+| Property  | Type      | Required | Description                                                                                                  |
+|-----------|-----------|----------|--------------------------------------------------------------------------------------------------------------|
 | `dev`     | `boolean` | `false`  | If set to `true`, the callback function will be called when building in development mode.                    |
 | `build`   | `boolean` | `false`  | If set to `true`, the callback function will be called when building in production mode.                     |
 | `server`  | `boolean` | `false`  | If set to `true`, the callback function will be called when building the server bundle.                      |

package/{3.api → 4.api}/5.kit/16.layers.md

@@ -85,18 +85,18 @@ This ordering matches Nuxt's layer resolution system, where user-defined configu
 
 **`LayerDirectories`**: An object containing the resolved directory paths for a layer.
 
-| Property        | Type     | Description                                                                    |
-| --------------- | -------- | ------------------------------------------------------------------------------ |
-| `root`          | `string` | The root directory of the layer (equivalent to `rootDir`)                     |
-| `server`        | `string` | The server directory for Nitro server-side code                               |
-| `modules`       | `string` | The local modules directory                                                    |
-| `shared`        | `string` | The shared directory for code used by both client and server                  |
-| `app`           | `string` | The source directory of the layer (equivalent to `srcDir`)                    |
-| `public`        | `string` | The public directory for static assets                                         |
-| `appLayouts`    | `string` | The layouts directory for Vue layout components                                |
-| `appMiddleware` | `string` | The middleware directory for route middleware                                  |
-| `appPages`      | `string` | The pages directory for file-based routing                                    |
-| `appPlugins`    | `string` | The plugins directory for Nuxt plugins                                        |
+| Property        | Type     | Description                                                  |
+|-----------------|----------|--------------------------------------------------------------|
+| `root`          | `string` | The root directory of the layer (equivalent to `rootDir`)    |
+| `server`        | `string` | The server directory for Nitro server-side code              |
+| `modules`       | `string` | The local modules directory                                  |
+| `shared`        | `string` | The shared directory for code used by both client and server |
+| `app`           | `string` | The source directory of the layer (equivalent to `srcDir`)   |
+| `public`        | `string` | The public directory for static assets                       |
+| `appLayouts`    | `string` | The layouts directory for Vue layout components              |
+| `appMiddleware` | `string` | The middleware directory for route middleware                |
+| `appPages`      | `string` | The pages directory for file-based routing                   |
+| `appPlugins`    | `string` | The plugins directory for Nuxt plugins                       |
 
 ### Examples
 

package/{3.api → 4.api}/5.kit/2.programmatic.md

@@ -4,7 +4,7 @@ description: Nuxt Kit provides a set of utilities to help you work with Nuxt pro
 links:
   - label: Source
     icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/kit/src/loader
+    to: https://github.com/nuxt/nuxt/tree/main/packages/kit/src/loader
     size: xs
 ---
 
@@ -31,7 +31,7 @@ function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
 
 ## `buildNuxt`
 
-Build Nuxt programmatically. It will invoke the builder (currently [@nuxt/vite-builder](https://github.com/nuxt/nuxt/blob/main/packages/vite) or [@nuxt/webpack-builder](https://github.com/nuxt/nuxt/blob/main/packages/webpack)) to bundle the application.
+Build Nuxt programmatically. It will invoke the builder (currently [@nuxt/vite-builder](https://github.com/nuxt/nuxt/tree/main/packages/vite) or [@nuxt/webpack-builder](https://github.com/nuxt/nuxt/tree/main/packages/webpack)) to bundle the application.
 
 ### Type