---
title: "兼容性"
description: "Nuxt Kit 提供了一组工具来帮助您检查模块与不同 Nuxt 版本的兼容性。"
canonical_url: "https://nuxt.zhcndoc.com/docs/4.x/api/kit/compatibility"
---
# 兼容性

> Nuxt Kit 提供了一组工具来帮助您检查模块与不同 Nuxt 版本的兼容性。

Nuxt Kit 实用工具可以在 Nuxt 3、带有 Bridge 的 Nuxt 2 甚至不带 Bridge 的 Nuxt 2 中使用。为确保您的模块与所有版本兼容，您可以使用 `checkNuxtCompatibility`、`assertNuxtCompatibility` 和 `hasNuxtCompatibility` 函数。它们会检查当前的 Nuxt 版本是否满足您提供的约束。您还可以使用 `isNuxt2`、`isNuxt3` 和 `getNuxtVersion` 函数进行更细粒度的检查。

## `checkNuxtCompatibility`

检查当前 Nuxt 版本是否满足约束。如果不满足，则返回一个消息数组。Nuxt 2 版本还会检查 `bridge` 支持。

### 使用方法

```ts twoslash
import { checkNuxtCompatibility, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  async setup (_options, nuxt) {
    const issues = await checkNuxtCompatibility({ nuxt: '^2.16.0' }, nuxt)
    if (issues.length) {
      console.warn('Nuxt compatibility issues found:\n' + issues.toString())
    } else {
      // do something
    }
  },
})
```

### 类型

```ts
function checkNuxtCompatibility (constraints: NuxtCompatibility, nuxt?: Nuxt): Promise<NuxtCompatibilityIssues>
```

### 参数

**`constraints`**：要检查的版本和构建器约束。它接受以下属性：

| 属性       | 类型                                           | 必填      | 描述                                                                        |
| -------- | -------------------------------------------- | ------- | ------------------------------------------------------------------------- |
| `nuxt`   | `string`                                     | `false` | Nuxt 版本，采用 semver 格式。版本可以用 Node.js 的方式定义，例如：`>=2.15.0 <3.0.0`。            |
| `bridge` | `Record<string, string \| false>`{lang="ts"} | `false` | 指定特定 Nuxt 构建器（如 `vite`、`webpack` 或 `rspack`）的版本约束或禁用兼容性检查。使用 `false` 来禁用。 |

**`nuxt`**：Nuxt 实例。如果未提供，将通过调用 `useNuxt()` 从上下文中获取。

## `assertNuxtCompatibility`

断言当前 Nuxt 版本满足约束。如果不满足，则抛出包含问题列表的字符串错误。

### 类型

```ts twoslash
// @errors: 2391
import type { Nuxt, NuxtCompatibility } from '@nuxt/schema'
// ---cut---
function assertNuxtCompatibility (constraints: NuxtCompatibility, nuxt?: Nuxt): Promise<true>
```

### 参数

**`constraints`**：要检查的版本和构建器约束。详情请参阅 [`checkNuxtCompatibility` 中的约束表](https://nuxt.zhcndoc.com/docs/4.x/api/kit/compatibility#parameters)。

**`nuxt`**：Nuxt 实例。如果未提供，将通过调用 `useNuxt()` 从上下文中获取。

## `hasNuxtCompatibility`

检查当前 Nuxt 版本是否满足约束。如果所有约束都满足则返回 `true`，否则返回 `false`。Nuxt 2 版本还会检查 `bridge` 支持。

### 使用方法

```ts twoslash
import { defineNuxtModule, hasNuxtCompatibility } from '@nuxt/kit'

export default defineNuxtModule({
  async setup (_options, nuxt) {
    const usingNewPostcss = await hasNuxtCompatibility({ nuxt: '^2.16.0' }, nuxt)
    if (usingNewPostcss) {
      // do something
    } else {
      // do something else
    }
  },
})
```

### 类型

```ts
function hasNuxtCompatibility (constraints: NuxtCompatibility, nuxt?: Nuxt): Promise<boolean>
```

### 参数

**`constraints`**：要检查的版本和构建器约束。详情请参阅 [`checkNuxtCompatibility` 中的约束表](https://nuxt.zhcndoc.com/docs/4.x/api/kit/compatibility#parameters)。

**`nuxt`**：Nuxt 实例。如果未提供，将通过调用 `useNuxt()` 从上下文中获取。

## `isNuxtMajorVersion`

检查当前 Nuxt 实例是否为指定的主版本

### 使用方法

```ts twoslash
import { defineNuxtModule, isNuxtMajorVersion } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    if (isNuxtMajorVersion(3)) {
      // do something for Nuxt 3
    } else {
      // do something else for other versions
    }
  },
})
```

### 类型

```ts
function isNuxtMajorVersion (major: number, nuxt?: Nuxt): boolean
```

### 参数

**`major`**：要检查的主版本号。

**`nuxt`**：Nuxt 实例。如果未提供，将通过调用 `useNuxt()` 从上下文中获取。

## `isNuxt3`

检查当前 Nuxt 版本是否为 3.x。

::note
改用 `isNuxtMajorVersion(2, nuxt)`。此方法可能会在 @nuxt/kit v5 或未来的主要版本中移除。
::

### 类型

```ts
function isNuxt3 (nuxt?: Nuxt): boolean
```

### 参数

**`nuxt`**：Nuxt 实例。如果未提供，将通过调用 `useNuxt()` 从上下文中获取。

## `isNuxt2`

检查当前 Nuxt 版本是否为 2.x。

::note
改用 `isNuxtMajorVersion(2, nuxt)`。此方法可能会在 @nuxt/kit v5 或未来的主要版本中移除。
::

### 类型

```ts
function isNuxt2 (nuxt?: Nuxt): boolean
```

### 参数

**`nuxt`**：Nuxt 实例。如果未提供，将通过调用 `useNuxt()` 从上下文中获取。

## `getNuxtVersion`

返回当前的 Nuxt 版本。

### 类型

```ts
function getNuxtVersion (nuxt?: Nuxt): string
```

### 参数

**`nuxt`**：Nuxt 实例。如果未提供，将通过调用 `useNuxt()` 从上下文中获取。

---

- [源码](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/compatibility.ts)


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.