Совместимость

Утилиты Nuxt Kit можно использовать в Nuxt 3, Nuxt 2 с Bridge и даже в Nuxt 2 без Bridge. Чтобы убедиться, что ваш модуль совместим со всеми версиями, вы можете использовать функции 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?: {
    // Установите `false`, если ваш модуль не совместим со сборщиком
    // или semver-совместимую строку ограничения версии
    vite?: false | string;
    webpack?: false | string;
  };
}

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 в семантическом версионированном формате. Версии могут быть заданы в стиле 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 в семантическом версионированном формате. Версии могут быть заданы в стиле 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().