Skip to content

vue-i18n / general / ComposerTranslation

Интерфейс: ComposerTranslation()<Messages, Locales, DefinedLocaleMessage, C, M, ResourceKeys>

Функции перевода локализованных сообщений

Примечания

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

Композиция Vue I18n

Type Parameters

### Тип параметраЗначение по умолчанию
Messages extends Record<string, any>object
Locales"en-US"
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage>RemovedIndexResources<DefineLocaleMessage>
CIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
MIsEmptyObject<Messages> extends false ? TranslationsPaths<Messages> : never
ResourceKeys extends C | MIsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never

Call Signature

ts
ComposerTranslation<Key>(key): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

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

Если указан I18nScope 'local' или некоторые UseI18nOptions при использовании useI18n, то перевод выполняется с приоритетом локального масштаба, чем глобального масштаба.

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

См. также:

Вызов функции

ts
ComposerTranslation<Key>(key, plural): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

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

См. также:

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    plural, 
    options): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

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

О подробностях опций см. в TranslateOptions.

См. также:

Вызов функции

ts
ComposerTranslation<Key>(key, defaultMsg): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

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

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    defaultMsg, 
    options): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

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

О подробностях опций см. в TranslateOptions.

Вызов функции

ts
ComposerTranslation<Key>(key, list): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

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

См. также:

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    list, 
    plural): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

См. также:

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    list, 
    defaultMsg): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

См. также:

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

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    list, 
    options): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

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

О подробностях опций см. в TranslateOptions.

Как использовать подробнее:

Вызов функции

ts
ComposerTranslation<Key>(key, named): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

ПараметрТипОписание
keynumber | ResourceKeys | KeyКлюч целевого локализованного сообщения
namedNamedValueЗначения именованной интерполяции

Возвращает

string

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

Примечания

Перегрузка t.

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

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

См. также:

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    named, 
    plural): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

См. также:

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    named, 
    defaultMsg): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

См. также:

Вызов функции

ts
ComposerTranslation<Key>(
    key, 
    named, 
    options): string;

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

Параметры типа

Тип параметра
Key extends string

Параметры

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

Возвращает

string

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

Примечания

Перегрузка t.

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

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

О подробностях опций см. в TranslateOptions.

Как использовать подробнее: