Compatibility
Nuxt Kit 工具可以在 Nuxt 3、带有 Bridge 的 Nuxt 2 甚至不带 Bridge 的 Nuxt 2 中使用。为了确保你的模块与所有版本兼容，你可以使用 checkNuxtCompatibility、assertNuxtCompatibility 和 hasNuxtCompatibility 函数。它们将检查当前 Nuxt 版本是否满足你提供的约束条件。此外，你还可以使用 isNuxt2、isNuxt3 和 getNuxtVersion 函数进行更详细的检查。
checkNuxtCompatibility
检查当前 Nuxt 版本是否满足约束条件。如果不满足，返回一个消息数组。Nuxt 2 版本还会检查 bridge 支持。
类型
async function checkNuxtCompatibility(
constraints: NuxtCompatibility,
nuxt?: Nuxt
): Promise<NuxtCompatibilityIssues>;
interface NuxtCompatibility {
nuxt?: string;
bridge?: boolean;
}
interface NuxtCompatibilityIssue {
name: string;
message: string;
}
interface NuxtCompatibilityIssues extends Array<NuxtCompatibilityIssue> {
toString(): string;
}
参数
constraints
类型: NuxtCompatibility
默认值: {}
要检查的约束条件。它接受以下属性：
nuxt（可选）
类型:string
Nuxt 版本，使用 semver 格式。版本可以以 Node.js 的方式定义，例如：>=2.15.0 <3.0.0。bridge（可选）
类型:boolean
如果设置为true，它将检查当前 Nuxt 版本是否支持bridge。
nuxt
类型: Nuxt
默认值: useNuxt()
Nuxt 实例。如果未提供，它将通过 useNuxt() 调用从上下文中获取。
assertNuxtCompatibility
断言当前 Nuxt 版本是否满足约束条件。如果不满足，将抛出带有问题列表的错误。
类型
async function assertNuxtCompatibility(
constraints: NuxtCompatibility,
nuxt?: Nuxt
): Promise<true>;
interface NuxtCompatibility {
nuxt?: string;
bridge?: boolean;
}
参数
constraints
类型: NuxtCompatibility
默认值: {}
要检查的约束条件。它接受以下属性：
nuxt（可选）
类型:string
Nuxt 版本，使用 semver 格式。版本可以以 Node.js 的方式定义，例如：>=2.15.0 <3.0.0。bridge（可选）
类型:boolean
如果设置为true，它将检查当前 Nuxt 版本是否支持bridge。
nuxt
类型: Nuxt
默认值: useNuxt()
Nuxt 实例。如果未提供，它将通过 useNuxt() 调用从上下文中获取。
hasNuxtCompatibility
检查当前 Nuxt 版本是否满足约束条件。如果所有约束条件都满足，返回 true，否则返回 false。Nuxt 2 版本还会检查 bridge 支持。
类型
async function hasNuxtCompatibility(
constraints: NuxtCompatibility,
nuxt?: Nuxt
): Promise<boolean>;
interface NuxtCompatibility {
nuxt?: string;
bridge?: boolean;
}
参数
constraints
类型: NuxtCompatibility
默认值: {}
要检查的约束条件。它接受以下属性：
nuxt（可选）
类型:string
Nuxt 版本，使用 semver 格式。版本可以以 Node.js 的方式定义，例如：>=2.15.0 <3.0.0。bridge（可选）
类型:boolean
如果设置为true，它将检查当前 Nuxt 版本是否支持bridge。
nuxt
类型: Nuxt
默认值: useNuxt()
Nuxt 实例。如果未提供，它将通过 useNuxt() 调用从上下文中获取。
isNuxt2
检查当前 Nuxt 版本是否为 2.x。
类型
function isNuxt2(nuxt?: Nuxt): boolean;
参数
nuxt
类型: Nuxt
默认值: useNuxt()
Nuxt 实例。如果未提供，它将通过 useNuxt() 调用从上下文中获取。
isNuxt3
检查当前 Nuxt 版本是否为 3.x。
类型
function isNuxt3(nuxt?: Nuxt): boolean;
参数
nuxt
类型: Nuxt
默认值: useNuxt()
Nuxt 实例。如果未提供，它将通过 useNuxt() 调用从上下文中获取。
getNuxtVersion
返回当前 Nuxt 版本。
类型
function getNuxtVersion(nuxt?: Nuxt): string;
参数
nuxt
类型: Nuxt
默认值: useNuxt()
Nuxt 实例。如果未提供，它将通过 useNuxt() 调用从上下文中获取。