Устаревший API

Choice

Подпись:

export type Choice = number;

УСТАРЕЛО

будет удалено в vue-i18n v12

DateTimeFormatResult

Подпись:

export type DateTimeFormatResult = string;

УСТАРЕЛО

будет удалено в vue-i18n v12

LocaleMessageObject

Подпись:

export type LocaleMessageObject<Message = string> = LocaleMessageDictionary<Message>;

УСТАРЕЛО

будет удалено в vue-i18n v12

NumberFormatResult

Подпись:

export type NumberFormatResult = string;

УСТАРЕЛО

будет удалено в vue-i18n v12

PluralizationRulesMap

Подпись:

export type PluralizationRulesMap = {
    [locale: string]: PluralizationRule;
};

УСТАРЕЛО

будет удалено в vue-i18n v12

TranslateResult

Подпись:

export type TranslateResult = string;

УСТАРЕЛО

будет удалено в vue-i18n v12

VueI18n

Устаревшие интерфейсы VueI18n

Подпись:

export interface VueI18n<Messages extends Record<string, any> = {}, DateTimeFormats extends Record<string, any> = {}, NumberFormats extends Record<string, any> = {}, OptionLocale = Locale, ResourceLocales = PickupLocales<NonNullable<Messages>> | PickupLocales<NonNullable<DateTimeFormats>> | PickupLocales<NonNullable<NumberFormats>>, Locales = Locale extends GeneratedLocale ? GeneratedLocale : OptionLocale extends string ? [ResourceLocales] extends [never] ? Locale : ResourceLocales : OptionLocale | ResourceLocales, Composition extends Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale> = Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale>>

УСТАРЕЛО

будет удалено в vue-i18n v12

Детали

Этот интерфейс совместим с интерфейсом класса VueI18n (предоставляется с Vue I18n v8.x).

availableLocales

Подпись:

readonly availableLocales: Composition['availableLocales'];

Детали

Список доступных локалей в messages в лексикографическом порядке.

d

Форматирование даты и времени

Подпись:

d: VueI18nDateTimeFormatting<DateTimeFormats, Locales, RemoveIndexSignature<{
        [K in keyof DefineDateTimeFormat]: DefineDateTimeFormat[K];
    }>>;

Детали

О функциях подробнее, см. VueI18nDateTimeFormatting

datetimeFormats

Подпись:

readonly datetimeFormats: {
        [K in keyof DateTimeFormats]: DateTimeFormats[K];
    };

Детали

Форматы даты и времени локализации.

Смотрите также

• Форматирование даты и времени

escapeParameterHtml

Подпись:

escapeParameterHtml: Composition['escapeParameter'];

Детали

Указывается, экранируются ли параметры интерполяции перед переводом сообщения.

Смотрите также

• HTML-сообщение

fallbackLocale

Подпись:

fallbackLocale: FallbackLocales<Locales>;

Детали

Текущие локали для резервирования, используемые этим экземпляром VueI18n.

Смотрите также

• Резервирование

formatFallbackMessages

Подпись:

formatFallbackMessages: Composition['fallbackFormat'];

Детали

Указывает, подавлять ли предупреждения при резервировании из fallbackLocale или корня.

Смотрите также

• Резервирование

getDateTimeFormat

Получить формат даты и времени

Подпись:

getDateTimeFormat: Composition['getDateTimeFormat'];

Детали

Получить формат даты и времени из инстанса VueI18n datetimeFormats.

getLocaleMessage

Получить локальное сообщение

Подпись:

getLocaleMessage: Composition['getLocaleMessage'];

Детали

Получить локальное сообщение из инстанса VueI18n messages.

getNumberFormat

Получить формат числа

Подпись:

getNumberFormat: Composition['getNumberFormat'];

Детали

Получить формат числа из инстанса VueI18n numberFormats.

id

Подпись:

id: number;

Детали

ID экземпляра.

locale

Подпись:

locale: Locales;

Детали

Текущая локаль, используемая этим экземпляром VueI18n.

Если локаль содержит территорию и диалект, эта локаль содержит неявное резервирование.

Смотрите также

• Область действия и изменение локали

mergeDateTimeFormat

Объединить формат даты и времени

Подпись:

mergeDateTimeFormat: Composition['mergeDateTimeFormat'];

Детали

Объединить формат даты и времени в инстансе VueI18n datetimeFormats.

mergeLocaleMessage

Объединить локальное сообщение

Подпись:

mergeLocaleMessage: Composition['mergeLocaleMessage'];

Детали

Объединить локальное сообщение в инстансе VueI18n messages.

mergeNumberFormat

Объединить формат числа

Подпись:

mergeNumberFormat: Composition['mergeNumberFormat'];

Детали

Объединить формат числа в инстансе VueI18n numberFormats.

messages

Подпись:

readonly messages: {
        [K in keyof Messages]: Messages[K];
    };

Детали

Локальные сообщения локализации.

Смотрите также

• Начало работы

missing

Подпись:

missing: MissingHandler | null;

Детали

Обработчик отсутствующей локализации.

modifiers

Подпись:

readonly modifiers: Composition['modifiers'];

Детали

Пользовательские модификаторы для связанных сообщений.

Смотрите также

• Пользовательские модификаторы

n

Форматирование чисел

Подпись:

n: VueI18nNumberFormatting<NumberFormats, Locales, RemoveIndexSignature<{
        [K in keyof DefineNumberFormat]: DefineNumberFormat[K];
    }>>;

Детали

О функциях подробнее, см. VueI18nNumberFormatting

numberFormats

Подпись:

readonly numberFormats: {
        [K in keyof NumberFormats]: NumberFormats[K];
    };

Детали

Форматы чисел локализации.

Смотрите также

• Форматирование чисел

pluralizationRules

Набор правил для множественного числа слов

Подпись:

pluralizationRules: Composition['pluralRules'];

Смотрите также

• Пользовательское множественное число

postTranslation

Подпись:

postTranslation: PostTranslationHandler<VueMessageType> | null;

Детали

Обработчик постобработки перевода.

rt

Разрешить перевод локального сообщения

Подпись:

rt: VueI18nResolveLocaleMessageTranslation<Locales>;

Детали

О функциях подробнее, см. VueI18nResolveLocaleMessageTranslation

setDateTimeFormat

Установить формат даты и времени

Подпись:

setDateTimeFormat: Composition['setDateTimeFormat'];

Детали

Установить формат даты и времени в инстансе VueI18n datetimeFormats.

setLocaleMessage

Установить локальное сообщение

Подпись:

setLocaleMessage: Composition['setLocaleMessage'];

Детали

Установить локальное сообщение в инстансе VueI18n messages.

setNumberFormat

Установить формат числа

Подпись:

setNumberFormat: Composition['setNumberFormat'];

Детали

Установить формат числа в инстансе VueI18n numberFormats.

silentFallbackWarn

Подпись:

silentFallbackWarn: Composition['fallbackWarn'];

Детали

Указывает, подавлять ли предупреждения о резервировании в случае сбоя локализации.

silentTranslationWarn

Подпись:

silentTranslationWarn: Composition['missingWarn'];

Детали

Указывает, подавлять ли выводимые предупреждения при сбое локализации.

Смотрите также

• Резервирование

sync

Подпись:

sync: Composition['inheritLocale'];

Детали

Указывает, синхронизировать ли локаль уровня корня с локалью локализации компонента.

Смотрите также

• Локальная область

t

Перевод локального сообщения

Подпись:

t: VueI18nTranslation<Messages, Locales, RemoveIndexSignature<{
        [K in keyof DefineLocaleMessage]: DefineLocaleMessage[K];
    }>>;

Детали

О функциях подробнее, см. VueI18nTranslation

tm

Получатель локальных сообщений

Подпись:

tm: Composition['tm'];

Детали

Если указаны опции i18n компонента, то получать предпочтительно локальные локальные сообщения вместо глобальных.

Если опции i18n компонента не указаны, получать с глобальными локальными сообщениями.

На основе текущей locale локальные сообщения будут возвращаться из сообщений экземпляра Composer.

Если вы измените locale, возвращаемые локальные сообщения тоже будут соответствовать этой локали.

Если нет локальных сообщений для заданного key в сообщениях экземпляра Composer, они будут возвращены с резервированием.

WARNING

Вам нужно использовать rt для локального сообщения, возвращенного tm. Смотрите детали rt.

Примеры

шаблон:

<div class="container">
  <template v-for="content in $tm('contents')">
    <h2>{{ $rt(content.title) }}</h2>
    <p v-for="paragraph in content.paragraphs">
     {{ $rt(paragraph) }}
    </p>
  </template>
</div>

import { createI18n } from 'vue-i18n'

const i18n = createI18n({
  messages: {
    en: {
      contents: [
        {
          title: 'Title1',
          // ...
          paragraphs: [
            // ...
          ]
        }
      ]
    }
  }
  // ...
})

warnHtmlInMessage

Подпись:

warnHtmlInMessage: WarnHtmlInMessageLevel;

Детали

Указывает, разрешено ли использовать локальные сообщения с форматированием HTML.

Если вы установите warn или error, будет проверяться локальные сообщения на инстансе VueI18n.

Если вы указали warn, будет выводиться предупреждение в консоли.

Если вы указали error, произойдет ошибка.

Смотрите также

• HTML-сообщение
• Изменение значения по умолчанию опции warnHtmlInMessage

te(key, locale)

Проверить существование перевода локального сообщения

Подпись:

te<Str extends string, Key extends PickupKeys<Messages> = PickupKeys<Messages>>(key: Str | Key, locale?: Locales): boolean;

Детали

Проверяет, существует ли локальное сообщение на инстансе VueI18n messages.

Если вы указали locale, проверить локальные сообщения locale.

Параметры

Параметр	Тип	Описание
key	Str | Key	Ключ целевого локального сообщения
locale	Locales	Целевая локаль

Возвращает

Если найдено локальное сообщение, true, иначе false

VueI18nDateTimeFormatting

Функции форматирования даты и времени для устаревших интерфейсов VueI18n

Подпись:

export interface VueI18nDateTimeFormatting<DateTimeFormats extends Record<string, any> = {}, Locales = 'en-US', DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> = RemovedIndexResources<DefineDateTimeFormat>, C = IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{
    [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K];
}> : never, M = IsEmptyObject<DateTimeFormats> extends false ? PickupFormatKeys<DateTimeFormats> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>

УСТАРЕЛО

будет удалено в vue-i18n v12

Детали

Это интерфейс для VueI18n

(value: number | Date): DateTimeFormatResult;

Форматирование даты и времени

Подпись:

(value: number | Date): DateTimeFormatResult;

Детали

Если используется в реактивном контексте, она пересчитывается при изменении локали.

Если указаны опции i18n компонента, форматируется предпочтительно локальными форматами, а не глобальными.

Если опции i18n компонента не указаны, форматируется с глобальными форматами.

Смотрите также

• Форматирование даты и времени

Параметры

Параметр	Тип	Описание
value	number | Date	Значение, число метки времени или экземпляр Date

Возвращает

Отформатированное значение

(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;

Форматирование даты и времени

Подпись:

<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;

Детали

Перегрузка d. Подробнее см. подпись вызова.

Параметры

Параметр	Тип	Описание
value	Value	Значение, число метки времени или экземпляр Date
key	Key | ResourceKeys	Ключ формата даты и времени

Возвращает

Отформатированное значение

(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;

Форматирование даты и времени

Подпись:

<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;

Детали

Перегрузка d. Подробнее см. подпись вызова.

Параметры

Параметр	Тип	Описание
value	Value	Значение, число метки времени или экземпляр Date
key	Key | ResourceKeys	Ключ формата даты и времени
locale	Locales	Локаль, используется вместо глобальной или локальной

Возвращает

Отформатированное значение

(value: number | Date, args: { [key: string]: string | boolean | number; }): DateTimeFormatResult;

Форматирование даты и времени

Подпись:

(value: number | Date, args: {
        [key: string]: string | boolean | number;
    }): DateTimeFormatResult;

Детали

Перегрузка d. Подробнее см. подпись вызова.

Параметры

Параметр	Тип	Описание
value	number | Date	Значение, число метки времени или экземпляр Date
args	{ [key: string]: string | boolean | number; }	Значения аргументов

Возвращает

Отформатированное значение

VueI18nNumberFormatting

Функции форматирования чисел для устаревших интерфейсов VueI18n

Подпись:

export interface VueI18nNumberFormatting<NumberFormats extends Record<string, any> = {}, Locales = 'en-US', DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> = RemovedIndexResources<DefineNumberFormat>, C = IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{
    [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K];
}> : never, M = IsEmptyObject<NumberFormats> extends false ? PickupFormatKeys<NumberFormats> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>

УСТАРЕЛО

будет удалено в vue-i18n v12

Детали

Это интерфейс для VueI18n

(value: number): NumberFormatResult;

Форматирование чисел

Подпись:

(value: number): NumberFormatResult;

Детали

Если используется в реактивном контексте, она пересчитывается при изменении локали.

Если указаны опции i18n компонента, форматируется предпочтительно локальными форматами, а не глобальными.

Если опции i18n компонента не указаны, форматируется с глобальными форматами.

Смотрите также

• Форматирование чисел

Параметры

Параметр	Тип	Описание
value	number	Числовое значение

Возвращает

Отформатированное значение

(value: number, key: Key | ResourceKeys): NumberFormatResult;

Форматирование чисел

Подпись:

<Key extends string = string>(value: number, key: Key | ResourceKeys): NumberFormatResult;

Детали

Перегрузка n. Подробнее см. подпись вызова.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
key	Key | ResourceKeys	Ключ формата числа

Возвращает

Отформатированное значение

(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;

Форматирование чисел

Подпись:

<Key extends string = string>(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;

Детали

Перегрузка n. Подробнее см. подпись вызова.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
key	Key | ResourceKeys	Ключ формата числа
locale	Locales	Локаль, используется вместо глобальной или локальной

Возвращает

Отформатированное значение

(value: number, args: { [key: string]: string | boolean | number; }): NumberFormatResult;

Форматирование чисел

Подпись:

(value: number, args: {
        [key: string]: string | boolean | number;
    }): NumberFormatResult;

Детали

Перегрузка n. Подробнее см. подпись вызова.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
args	{ [key: string]: string | boolean | number; }	Значения аргументов

Возвращает

Отформатированное значение

VueI18nOptions

Опции VueI18n

Подпись:

export interface VueI18nOptions<Schema extends {
    message?: unknown;
    datetime?: unknown;
    number?: unknown;
} = {
    message: DefaultLocaleMessageSchema;
    datetime: DefaultDateTimeFormatSchema;
    number: DefaultNumberFormatSchema;
}, Locales extends {
    messages: unknown;
    datetimeFormats: unknown;
    numberFormats: unknown;
} | string = Locale, Options extends ComposerOptions<Schema, Locales> = ComposerOptions<Schema, Locales>>

УСТАРЕЛО

будет удалено в vue-i18n v12

Детали

Эта опция совместима с опциями конструктора класса VueI18n (предоставляется с Vue I18n v8.x)

availableLocales

Подпись:

availableLocales?: Locale[];

Детали

Список доступных локалей в сообщениях в лексикографическом порядке.

Значение по умолчанию

[]

datetime

datetimeFormats

escapeParameterHtml

Подпись:

escapeParameterHtml?: Options['escapeParameter'];

Детали

Указывает, следует ли экранировать параметры для значений списков или именованной интерполяции. При включении этой опции: - Экранируются специальные символы HTML (<, >, ", ', &, /, =) в параметрах интерполяции - Очищается финальный HTML, чтобы предотвратить XSS-атаки, путем: - Экранирования опасных символов в значениях атрибутов HTML - Нейтрализации атрибутов обработчиков событий (onclick, onerror и т. п.) - Отключения URL javascript: в href, src, action, formaction и style атрибутах

Это полезно, когда вывод перевода используется в v-html, и ресурс перевода содержит HTML-разметку (например, вокруг пользовательского значения).

Этот шаблон использования обычно встречается, когда передаются заранее вычисленные текстовые строки в компоненты UI.

Процесс экранирования включает замену следующих символов на их соответствующие HTML-сущности: <, >, ", '.

Установка escapeParameterHtml в true не должна нарушать существующую функциональность, но обеспечивает защиту от косвенных векторов XSS-атак.

Значение по умолчанию

false

Смотрите также

• HTML-сообщение — Использование опции escapeParameter

fallbackLocale

Подпись:

fallbackLocale?: Options['fallbackLocale'];

Детали

Локаль резервирования локализации.

Для более сложных определений резервирования смотрите fallback.

Значение по умолчанию

По умолчанию 'en-US' для locale, если он не указан, или это значение locale

Смотрите также

• Резервирование

fallbackRoot

Подпись:

fallbackRoot?: Options['fallbackRoot'];

Детали

В локализации компонента, указывает, следует ли возвращаться к уровню корня (глобальной области видимости) локализации при сбое локализации.

Если false, не возвращаться к корню.

Значение по умолчанию

true

Смотрите также

• Резервирование

flatJson

Подпись:

flatJson?: Options['flatJson'];

Детали

Разрешено использование плоских JSON-сообщений или нет

Значение по умолчанию

false

formatFallbackMessages

Подпись:

formatFallbackMessages?: Options['fallbackFormat'];

Детали

Указывает, подавлять ли предупреждения при резервировании из fallbackLocale или корня.

Значение по умолчанию

false

Смотрите также

• Резервирование

locale

Подпись:

locale?: Options['locale'];

Детали

Локаль локализации.

Если локаль содержит территорию и диалект, эта локаль содержит неявное резервирование.

Значение по умолчанию

'en-US'

Смотрите также

• Область действия и изменение локали

message

messageResolver

Подпись:

messageResolver?: MessageResolver;

Детали

Разрешитель сообщений для разрешения messages.

Если не указан, будет использоваться внутренний разрешитель сообщений vue-i18n по умолчанию.

Вам нужно реализовать разрешитель сообщений самостоятельно, который поддерживает следующие требования:

• Разрешать сообщения, используя локальное сообщение locale, переданное как первый аргумент разрешителя сообщений, и путь, переданный как второй аргумент.

• Если сообщение не может быть разрешено, необходимо вернуть null.

• Если будет возвращено null, разрешитель сообщений также будет вызван при резервировании, если включено fallbackLocale, и сообщение также нужно будет разрешить.

Разрешитель сообщений вызывается косвенно через следующие API:

• t

• te

• tm

• Компонент перевода

TIP

🆕 v9.2+

WARNING

Если вы используете разрешитель сообщений, настройка flatJson будет проигнорирована. То есть, вам нужно будет разрешать плоский JSON самостоятельно.

Значение по умолчанию

undefined

Смотрите также

• Резервирование

Примеры

Вот пример того, как настроить его с помощью createI18n:

import { createI18n } from 'vue-i18n'

// ваш разрешитель сообщений
function messageResolver(obj, path) {
  // простое разрешение сообщений!
  const msg = obj[path]
  return msg != null ? msg : null
}

// вызов с опцией I18n
const i18n = createI18n({
  locale: 'ja',
  messageResolver, // установите ваш разрешитель сообщений
  messages: {
    en: { ... },
    ja: { ... }
  }
})

// ниже ваш код ...
// ...

messages

missing

Подпись:

missing?: Options['missing'];

Детали

Обработчик отсутствующей локализации.

Обработчик вызывается с целевой локалью локализации, ключом пути локализации, экземпляром Vue и значениями.

Если обработчик отсутствующей локализации назначен, и возникла ошибка отсутствия локализации, он не будет выводить предупреждение.

Значение по умолчанию

null

modifiers

Подпись:

modifiers?: Options['modifiers'];

Детали

Пользовательские модификаторы для связанных сообщений.

Смотрите также

• Пользовательские модификаторы

number

numberFormats

pluralizationRules

Подпись:

pluralizationRules?: Options['pluralRules'];

Детали

Набор правил для множественного числа слов

Значение по умолчанию

{}

Смотрите также

• Пользовательское множественное число

postTranslation

Подпись:

postTranslation?: Options['postTranslation'];

Детали

Обработчик постобработки перевода. Обработчик вызывается после вызова $t и t.

Этот обработчик полезен, если вы хотите фильтровать переведенный текст, например, обрезать пробелы.

Значение по умолчанию

null

sharedMessages

Подпись:

sharedMessages?: LocaleMessages<VueMessageType>;

Детали

Общие локальные сообщения локализации для компонентов. Более подробное описание см. в локализации, основанной на компонентах.

Значение по умолчанию

undefined

Смотрите также

• Общие локальные сообщения для компонентов

silentFallbackWarn

Подпись:

silentFallbackWarn?: Options['fallbackWarn'];

Детали

Указывает, делать ли интерполяцию шаблона при отсутствии перевода для ключа в вашем языке.

Если true, пропустить написание шаблонов для вашего "базового" языка; ключи являются вашими шаблонами.

Значение по умолчанию

false

Смотрите также

• Резервирование

silentTranslationWarn

Подпись:

silentTranslationWarn?: Options['missingWarn'];

Детали

Указывает, подавлять ли выводимые предупреждения при сбое локализации.

Если true, подавлять предупреждения о сбое локализации.

Если вы используете регулярное выражение, можно подавить предупреждения о сбое локализации, которые соответствуют ключу перевода (например, t).

Значение по умолчанию

false

Смотрите также

• Резервирование

sync

Подпись:

sync?: boolean;

Детали

Указывает, синхронизировать ли локаль уровня корня с локалью локализации компонента.

Если false, независимо от локали уровня корня, локализация проводится для каждой локали компонента.

Значение по умолчанию

true

Смотрите также

• Локальная область

warnHtmlInMessage

Подпись:

warnHtmlInMessage?: WarnHtmlInMessageLevel;

Детали

Указывает, разрешено ли использовать локальные сообщения с форматированием HTML.

См. свойство warnHtmlInMessage.

Значение по умолчанию

'off'

Смотрите также

• HTML-сообщение
• Изменение значения по умолчанию опции warnHtmlInMessage

VueI18nResolveLocaleMessageTranslation

Функции разрешения перевода локального сообщения для устаревших интерфейсов VueI18n

Подпись:

export type VueI18nResolveLocaleMessageTranslation<Locales = 'en-US'> = ComposerResolveLocaleMessageTranslation<Locales>;

УСТАРЕЛО

будет удалено в vue-i18n v12

Детали

Это интерфейс для VueI18n. Этот интерфейс является псевдонимом ComposerResolveLocaleMessageTranslation.

VueI18nTranslation

Функции перевода локального сообщения для устаревших интерфейсов VueI18n

Подпись:

export interface VueI18nTranslation<Messages extends Record<string, any> = {}, Locales = 'en-US', DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>, C = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
    [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
}> : never, M = IsEmptyObject<Messages> extends false ? PickupKeys<Messages> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>

УСТАРЕЛО

будет удалено в vue-i18n v12

Детали

Это интерфейс для VueI18n

(key: Key | ResourceKeys): TranslateResult;

Перевод локального сообщения.

Подпись:

<Key extends string>(key: Key | ResourceKeys): TranslateResult;

Детали

Если используется в реактивном контексте, она пересчитывается при изменении локали.

Если указаны опции i18n компонента, перевод осуществляется предпочтительно локальными сообщениями вместо глобальных.

Если опции i18n компонента не указаны, перевод осуществляется с глобальными сообщениями.

Смотрите также

• Область действия и изменение локали

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;

Перевод локального сообщения.

Подпись:

<Key extends string>(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

Смотрите также

• Именованная интерполяция

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
named	Record<string, unknown>	Значения именованной интерполяции

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;

Перевод локального сообщения для именованной интерполяции и множественного числа

Подпись:

<Key extends string>(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t для каждого заполнителя x в локальных сообщениях должно быть {x}, и возвращается переведённое множественное число.

Смотрите также

• Множественное число
• Именованная интерполяция

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
named	NamedValue	Значения именованной интерполяции
plural	number	Какое множественное число получить. 1 возвращает первое.

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;

Перевод локального сообщения для именованной интерполяции и множественного числа

Подпись:

<Key extends string>(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t для каждого заполнителя x в локальных сообщениях должно быть {x}, и если перевод не найден, возвращается сообщение по умолчанию.

Смотрите также

• Именованная интерполяция

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
named	NamedValue	Значения именованной интерполяции
defaultMsg	string	Сообщение по умолчанию, возвращаемое, если перевод не найден

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;

Перевод локального сообщения для именованной интерполяции

Подпись:

<Key extends string>(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t для каждого заполнителя x в локальных сообщениях должно быть {x}.

Вы также можете подавить предупреждения, если перевод отсутствует в соответствии с опциями.

Подробнее об опциях см. .

Смотрите также

• Именованная интерполяция

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
named	NamedValue	Значения именованной интерполяции
options	TranslateOptions<Locales>	Дополнительные опции для перевода

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, plural: number): TranslateResult;

Перевод локального сообщения для множественного числа

Подпись:

<Key extends string>(key: Key | ResourceKeys, plural: number): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t возвращается множественное число переведенного сообщения.

Вы также можете подавить предупреждения, если перевод отсутствует в соответствии с опциями.

Смотрите также

• Множественное число

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
plural	number	Какое множественное число получить. 1 возвращает первое.

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;

Перевод локального сообщения для множественного числа

Подпись:

<Key extends string>(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t возвращается множественное число переведенного сообщения.

Вы также можете подавить предупреждения, если перевод отсутствует в соответствии с опциями.

Подробнее об опциях см. .

Смотрите также

• Множественное число

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
plural	number	Какое множественное число получить. 1 возвращает первое.
options	TranslateOptions<Locales>	Дополнительные опции для перевода

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;

Перевод локального сообщения для отсутствующего сообщения по умолчанию

Подпись:

<Key extends string>(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t, если перевод не найден, возвращается сообщение по умолчанию.

Вы также можете подавить предупреждения, если перевод отсутствует в соответствии с опциями.

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
defaultMsg	string	Сообщение по умолчанию, возвращаемое, если перевод не найден

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;

Перевод локального сообщения для отсутствующего сообщения по умолчанию

Подпись:

<Key extends string>(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t, если перевод не найден, возвращается сообщение по умолчанию.

Вы также можете подавить предупреждения, если перевод отсутствует в соответствии с опциями.

Подробнее об опциях см. .

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
defaultMsg	string	Сообщение по умолчанию, возвращаемое, если перевод не найден
options	TranslateOptions<Locales>	Дополнительные опции для перевода

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, list: unknown[]): TranslateResult;

Перевод локального сообщения.

Подпись:

<Key extends string>(key: Key | ResourceKeys, list: unknown[]): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

Смотрите также

• Интерполяция списка

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
list	unknown[]	Значения интерполяции списка

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;

Перевод локального сообщения для интерполяции списка и множественного числа

Подпись:

<Key extends string>(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t локальные сообщения должны содержать {0}, {1}, … для каждого заполнителя в списке, и возвращается множественное число переведенного сообщения.

Смотрите также

• Множественное число
• Интерполяция списка

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
list	unknown[]	Значения интерполяции списка
plural	number	Какое множественное число получить. 1 возвращает первое.

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;

Перевод локального сообщения для интерполяции списка и отсутствующего сообщения по умолчанию

Подпись:

<Key extends string>(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t локальные сообщения должны содержать {0}, {1}, … для каждого заполнителя в списке, и если перевод не найден, возвращается сообщение по умолчанию.

Смотрите также

• Интерполяция списка

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
list	unknown[]	Значения интерполяции списка
defaultMsg	string	Сообщение по умолчанию, возвращаемое, если перевод не найден

Возвращает

Переведенное сообщение

(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;

Перевод локального сообщения для интерполяции списка

Подпись:

<Key extends string>(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;

Детали

Перегрузка t. Подробнее см. подпись вызова.

В этой перегрузке t локальные сообщения должны содержать {0}, {1}, … для каждого заполнителя в списке.

Вы также можете подавить предупреждения, если перевод отсутствует в соответствии с опциями.

Подробнее об опциях см. .

Смотрите также

• Интерполяция списка

Параметры

Параметр	Тип	Описание
key	Key | ResourceKeys	Ключ целевого локального сообщения
list	unknown[]	Значения интерполяции списка
options	TranslateOptions<Locales>	Дополнительные опции для перевода

Возвращает

Переведенное сообщение

WarnHtmlInMessageLevel

Подпись:

export type WarnHtmlInMessageLevel = 'off' | 'warn' | 'error';

УСТАРЕЛО

будет удалено в vue-i18n v12