互換性 · Nuxt Kit

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;
  builder?: {
    // Set `false` if your module is not compatible with a builder
    // or a semver-compatible string version constraint
    vite?: false | string;
    webpack?: false | string;
  };
}

interface NuxtCompatibilityIssue {
  name: string;
  message: string;
}

interface NuxtCompatibilityIssues extends Array<NuxtCompatibilityIssue> {
  toString(): string;
}

パラメーター

`constraints`

型: NuxtCompatibility

デフォルト: {}

チェックする制約。次のプロパティを受け入れます。

nuxt (オプション)
型: string
semver形式のNuxtバージョン。バージョンは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
semver形式のNuxtバージョン。バージョンは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
semver形式のNuxtバージョン。バージョンは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()呼び出しを介してコンテキストから取得されます。

プログラムによる使用

Nuxt Kitは、Nuxtをプログラムで操作するのに役立つユーティリティのセットを提供します。これらの関数を使用すると、Nuxtの読み込み、ビルド、Nuxt設定の読み込みを行うことができます。

自動インポート

Nuxt Kitは、自動インポートを操作するのに役立つユーティリティのセットを提供します。これらの関数を使用すると、独自のユーティリティ、コンポーザブル、Vue APIを登録できます。