Nuxt Kitのユーティリティは、Nuxt 3、Bridgeを使用したNuxt 2、さらにはBridgeを使用しないNuxt 2でも使用できます。すべてのバージョンと互換性があることを確認するために、checkNuxtCompatibility、assertNuxtCompatibility、hasNuxtCompatibility関数を使用できます。これらの関数は、提供された制約を現在のNuxtバージョンが満たしているかどうかを確認します。また、より詳細なチェックのためにisNuxt2、isNuxt3、getNuxtVersion関数を使用することもできます。

checkNuxtCompatibility

現在のNuxtバージョンが制約を満たしているかどうかを確認します。満たしていない場合、メッセージの配列を返します。Nuxt 2バージョンではbridgeサポートも確認します。

使用法

import { defineNuxtModule, checkNuxtCompatibility } 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の互換性に問題があります:\n' + issues.toString())
    } else {
      // 何かを実行
    }
  }
})

型

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

パラメータ

constraints: チェックするバージョンとビルダーの制約。以下のプロパティを受け入れます:

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) {
      // 何かを実行
    } 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({
  async setup () {
    if (isNuxtMajorVersion(3)) {
      // Nuxt 3用の処理
    } else {
      // 他のバージョン用の処理
    }
  }
})

型

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

パラメータ

major: チェックするメジャーバージョン。

nuxt: Nuxtインスタンス。提供されない場合、useNuxt()呼び出しを通じてコンテキストから取得されます。

isNuxt3

現在のNuxtバージョンが3.xであるかどうかを確認します。

型

function isNuxt3(nuxt?: Nuxt): boolean;

パラメータ

nuxt: Nuxtインスタンス。提供されない場合、useNuxt()呼び出しを通じてコンテキストから取得されます。

isNuxt2

現在のNuxtバージョンが2.xであるかどうかを確認します。

型

function isNuxt2(nuxt?: Nuxt): boolean;

パラメータ

nuxt: Nuxtインスタンス。提供されない場合、useNuxt()呼び出しを通じてコンテキストから取得されます。

getNuxtVersion

現在のNuxtバージョンを返します。

型

function getNuxtVersion(nuxt?: Nuxt): string;

パラメータ

nuxt: Nuxtインスタンス。提供されない場合、useNuxt()呼び出しを通じてコンテキストから取得されます。

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

export default defineNuxtModule({
  async setup (_options, nuxt) {
    const issues = await checkNuxtCompatibility({ nuxt: '>=3.0.0' }, nuxt)
    if (issues.length) {
      console.warn('このモジュールはNuxt 3以上で動作します。現在の環境では一部機能が制限されます。')
      // Nuxt 2向けの代替処理など
    } else {
      // Nuxt 3向けの処理
    }
  }
})

import { defineNuxtModule, assertNuxtCompatibility } from '@nuxt/kit'

export default defineNuxtModule({
  async setup (_options, nuxt) {
    await assertNuxtCompatibility({ nuxt: '^2.16.0', bridge: { vite: '>=2.0.0' } }, nuxt)
    // ここまで来たら互換性は保証されている
  }
})

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

export default defineNuxtModule({
  async setup (_options, nuxt) {
    const isCompatible = await hasNuxtCompatibility({ nuxt: '^3.0.0' }, nuxt)
    if (isCompatible) {
      // Nuxt 3用の処理
    } else {
      // Nuxt 2用の処理
    }
  }
})