vue-i18n / vue / ComponentCustomProperties
Интерфейс: ComponentCustomProperties
Пользовательские свойства компонентов для Vue I18n
Инъекция Vue I18n
Методы
$d()
Вызов
$d(value): string;Форматирование даты и времени
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | string | number | Date | Значение, число временной метки или экземпляр Date |
Возвращает
string
отформатированное значение
Примечания
Если используется в реактивном контексте, будет пересчитываться при изменении локали.
В режиме I18nMode | Composition API $d внедряется через app.config.globalProperties. входные и выходные данные те же, что и у экземпляра Composer, и работает на глобальном уровне. Подробнее см. Composer#d | `Composer#d`.
Вызов
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, key): string;Форматирование даты и времени
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Value extends string | number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | Value | Значение, число временной метки или экземпляр Date |
key | Key | ResourceKeys | Ключ формата даты и времени |
Возвращает
string
отформатированное значение
Примечания
Перегруженный $d. Подробнее см. примечания к $d.
Вызов
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, options): string;Форматирование даты и времени
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Value extends string | number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | Value | Значение, число временной метки или экземпляр Date |
options | DateTimeOptions<Key | ResourceKeys> | Опции |
Возвращает
string
отформатированное значение
Примечания
Перегруженный $d. Подробнее см. примечания к $d.
Вызов
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(
value,
key,
locale): string;Форматирование даты и времени
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Value extends string | number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | Value | Значение, число временной метки или экземпляр Date |
key | Key | ResourceKeys | Ключ формата даты и времени |
locale | string | Локаль, необязательно, переопределяет глобальную или локальную локаль |
Возвращает
string
отформатированное значение
Примечания
Перегруженный $d. Подробнее см. примечания к $d.
Вызов
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys, OptionsType>(
value,
options,
locale): IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string;Форматирование даты и времени
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Value extends number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
OptionsType | DateTimeOptions<Key | ResourceKeys, string> |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | Value | Значение, число временной метки или экземпляр Date |
options | OptionsType | Опции |
locale | string | Локаль, необязательно, переопределяет глобальную или локальную локаль |
Возвращает
IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string
отформатированное значение
Примечания
Перегруженный $d. Подробнее см. примечания к $d.
$n()
Вызов
$n(value): string;Форматирование чисел
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | number | Числовое значение |
Возвращает
string
отформатированное значение
Примечания
Если используется в реактивном контексте, будет пересчитываться при изменении локали.
В режиме I18nMode | Composition API $n внедряется через app.config.globalProperties. входные и выходные данные те же, что и у экземпляра Composer, и работает на глобальном уровне. Подробнее см. Composer#n | `Composer.n`.
Вызов
$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(value, key): string;Форматирование чисел
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> | RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | number | Числовое значение |
key | Key | ResourceKeys | Ключ формата чисел |
Возвращает
string
отформатированное значение
Примечания
Перегруженный $n. Подробнее см. примечания к $n.
Вызов
$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(value, options): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;Форматирование чисел
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
OptionsType | NumberOptions<Key | ResourceKeys, string> |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | number | Числовое значение |
options | OptionsType | Опции, см. NumberOptions |
Возвращает
IsPart<OptionsType> extends true ? NumberFormatPart[] : string
отформатированное значение
Примечания
Перегруженный $n. Подробнее см. примечания к $n.
Вызов
$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(
value,
key,
locale): string;Форматирование чисел
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | number | Числовое значение |
key | Key | ResourceKeys | Ключ формата чисел |
locale | string | Локаль, необязательно, переопределяет глобальную или локальную локаль |
Возвращает
string
отформатированное значение
Примечания
Перегруженный $n. Подробнее см. примечания к $n.
Вызов
$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(
value,
options,
locale): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;Форматирование чисел
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
OptionsType | NumberOptions<Key | ResourceKeys, string> |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
value | number | Числовое значение |
options | OptionsType | Опции, см. NumberOptions |
locale | string | Локаль, необязательно, переопределяет глобальную или локальную локаль |
Возвращает
IsPart<OptionsType> extends true ? NumberFormatPart[] : string
отформатированное значение
Примечания
Перегруженный $n. Подробнее см. примечания к $n.
$rt()
Вызов
$rt(message): string;Разрешение перевода сообщения локали
Параметры
| Параметр | Тип | Описание |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | Целевое сообщение локали для разрешения. Необходимо указать сообщение локали, возвращённое $tm. |
Возвращает
string
переведённое сообщение
Примечания
Если используется в реактивном контексте, будет пересчитываться при изменении локали.
В режиме I18nMode | Composition API $rt внедряется через app.config.globalProperties. входные и выходные данные те же, что и у Composer, и работает на глобальном уровне. Подробнее см. Composer#rt | `Composer#rt`.
Вызов
$rt(
message,
plural,
options?): string;Разрешение перевода сообщения локали для множественного числа
Параметры
| Параметр | Тип | Описание |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | Целевое сообщение локали для разрешения. Необходимо указать сообщение локали, возвращённое $tm. |
plural | number | Какую строку множественного числа получить. 1 возвращает первую строку. |
options? | TranslateOptions<string> | Дополнительные опции для перевода |
Возвращает
string
Переведённое сообщение
Примечания
Перегруженный $rt. Подробнее см. примечания к $rt.
Вызов
$rt(
message,
list,
options?): string;Разрешение перевода сообщения локали для интерполяции списка
Параметры
| Параметр | Тип | Описание |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | Целевое сообщение локали для разрешения. Необходимо указать сообщение локали, возвращённое $tm. |
list | unknown[] | Значения интерполяции списка. |
options? | TranslateOptions<string> | Дополнительные опции для перевода |
Возвращает
string
Переведённое сообщение
Примечания
Перегруженный $rt. Подробнее см. примечания к $rt.
Вызов
$rt(
message,
named,
options?): string;Разрешение перевода сообщения локали для интерполяции по ключам
Параметры
| Параметр | Тип | Описание |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | Целевое сообщение локали для разрешения. Необходимо указать сообщение локали, возвращённое $tm. |
named | NamedValue | Значения интерполяции по ключам. |
options? | TranslateOptions<string> | Дополнительные опции для перевода |
Возвращает
string
Переведённое сообщение
Примечания
Перегруженный $rt. Подробнее см. примечания к $rt.
$t()
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
Возвращает
string
переведённое сообщение
Примечания
Если используется в реактивном контексте, будет пересчитываться при изменении локали.
В режиме I18nMode | Composition API $t внедряется через app.config.globalProperties. входные и выходные данные те же, что и у Composer, и работает на глобальном уровне. Подробнее см. Composer#t | `Composer#t`.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, plural): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
plural | number | Номер выбора множественного числа |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
plural,
options): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
plural | number | Какую строку множественного числа получить. 1 возвращает первую строку. |
options | TranslateOptions | Опции, см. TranslateOptions |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, defaultMsg): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
defaultMsg | string | Сообщение по умолчанию, которое будет возвращено, если перевод не найден |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
defaultMsg,
options): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
defaultMsg | string | Сообщение по умолчанию, которое будет возвращено, если перевод не найден |
options | TranslateOptions | Опции, см. TranslateOptions |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, list): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
list | unknown[] | Значения интерполяции списка |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
list,
plural): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
list | unknown[] | Значения интерполяции списка |
plural | number | Номер выбора множественного числа |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
list,
defaultMsg): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
list | unknown[] | Значения интерполяции списка |
defaultMsg | string | Сообщение по умолчанию, которое будет возвращено, если перевод не найден |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
list,
options): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
list | unknown[] | Значения интерполяции списка |
options | TranslateOptions | Опции, см. TranslateOptions |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, named): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
named | NamedValue | Значения интерполяции по ключам |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
named,
plural): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
named | NamedValue | Значения интерполяции по ключам |
plural | number | Номер выбора множественного числа |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
named,
defaultMsg): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
named | NamedValue | Значения интерполяции по ключам |
defaultMsg | string | Сообщение по умолчанию, которое будет возвращено, если перевод не найден |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
Вызов
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
named,
options): string;Перевод сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | number | Key | ResourceKeys | Ключ целевого сообщения локали |
named | NamedValue | Значения интерполяции по ключам |
options | TranslateOptions | Опции, см. TranslateOptions |
Возвращает
string
переведённое сообщение
Примечания
Перегруженный $t. Подробнее см. примечания к $t.
$te()
$te<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, locale?): boolean;Существует ли перевод сообщения
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | Key | ResourceKeys | Ключ целевого сообщения локали |
locale? | string | Локаль, необязательно, переопределяет глобальную или локальную локаль |
Возвращает
boolean
Если сообщение локали найдено, true, иначе false. Обратите внимание, что false возвращается даже если значение в ключе не подлежит переводу.
Примечания
Подробнее см. VueI18n#te | `VueI18n#te` или Composer#te | `Composer#te`.
$tm()
$tm<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key):
| {
}
| LocaleMessageValue<VueMessageType>;Получатель сообщений локали
Параметры типа
| Параметр типа | Тип по умолчанию |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
Параметры
| Параметр | Тип | Описание |
|---|---|---|
key | Key | ResourceKeys | Ключ целевого сообщения локали |
Возвращает
| { } | LocaleMessageValue<VueMessageType>
сообщения локали
Примечания
В режиме I18nMode | Composition API $tm внедряется через app.config.globalProperties. входные и выходные данные те же, что и у экземпляра Composer, и работает на глобальном уровне. Подробнее см. Composer#tm | `Composer.tm`. На основе текущей locale будут возвращены сообщения локали из сообщений экземпляра Composer. Если вы измените locale, возвращаемые сообщения локали также соответствуют новой локали. Если нет сообщений локали для заданного key в сообщениях экземпляра композера, они будут возвращены с использованием значения по умолчанию.
Свойства
$i18n
$i18n: ExportedGlobalComposer;Экспортированный глобальный экземпляр композера
Примечания
Вы можете получить экспортированный экземпляр композера, который экспортируется из глобального композера | экземпляра композера, созданного с помощью createI18n. Вы можете получить экспортированный экземпляр композера в режиме I18nMode | Composition API. Локали, сообщения локали и другие ресурсы, управляемые экземпляром, на который ссылается это свойство, действительны как глобальный уровень. Если пользовательская опция компонента i18n не указана, она аналогична экземпляру VueI18n, который можно получить через свойство I18n.global | global экземпляра i18n.