兼容性

源文件
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 的支持。

使用

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
    }
  },
})

类型

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

参数

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

属性类型必需描述
nuxtstringfalsesemver 格式的 Nuxt 版本。版本可以按 Node.js 的方式定义，例如：>=2.15.0 <3.0.0。
bridgeRecord<string, string | false>false指定版本约束或禁用特定 Nuxt 构建器（如 vite、webpack 或 rspack）的兼容性。使用 false 进行禁用。

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

assertNuxtCompatibility

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

类型

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

参数

constraints：要检查的版本和构建器约束。有关详细信息，请参阅 checkNuxtCompatibility 中的约束表。

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

hasNuxtCompatibility

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

使用

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
    }
  },
})

类型

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

参数

constraints：要检查的版本和构建器约束。有关详细信息，请参阅 checkNuxtCompatibility 中的约束表。

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

isNuxtMajorVersion

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

使用

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
    }
  },
})

类型

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

参数

major：要检查的主版本。

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

isNuxt3

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

请改用 isNuxtMajorVersion(2, nuxt)。这可能会在 @nuxt/kit v5 或未来的主版本中被移除。

类型

function isNuxt3 (nuxt?: Nuxt): boolean

参数

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

isNuxt2

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

请改用 isNuxtMajorVersion(2, nuxt)。这可能会在 @nuxt/kit v5 或未来的主版本中被移除。

类型

function isNuxt2 (nuxt?: Nuxt): boolean

参数

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

getNuxtVersion

返回当前的 Nuxt 版本。

类型

function getNuxtVersion (nuxt?: Nuxt): string

参数

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