Skip to content

vue-i18n / general / ComposerTranslation

Interfaz: ComposerTranslation()<Messages, Locales, DefinedLocaleMessage, C, M, ResourceKeys>

Funciones de traducción de mensajes locales

Comentarios

Esta es la interfaz para Composer

Composición de Vue I18n

Parámetros de Tipo

Parámetro de TipoTipo predeterminado
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

Firma de Llamada

ts
ComposerTranslation<Key>(key): string;

Traducción de mensaje local

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino

Devuelve

string

Mensaje traducido

Comentarios

Si esto se usa en un contexto reactivo, se volverá a evaluar una vez que cambie la configuración regional.

Si se especifica I18nScope 'local' o algunas UseI18nOptions en useI18n, se traduce preferentemente los mensajes locales del alcance local en lugar de los mensajes locales del alcance global.

Si no, entonces se traduce con los mensajes locales del alcance global.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para plurales

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
pluralnumberQué cadena plural obtener. 1 devuelve la primera.

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, devuelve un mensaje de traducción pluralizado.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para plurales

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
pluralnumberQué cadena plural obtener. 1 devuelve la primera.
optionsTranslateOptions<Locales>Opciones adicionales para traducción

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, devuelve un mensaje de traducción pluralizado.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Sobre detalles de las opciones, ver TranslateOptions.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para mensaje por defecto faltante

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
defaultMsgstringUn mensaje por defecto a devolver si no se encontró ninguna traducción

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, si no se encuentra ninguna traducción, devuelve un mensaje por defecto.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Firma de Llamada

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

Traducción de mensaje local para mensaje por defecto faltante

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
defaultMsgstringUn mensaje por defecto a devolver si no se encontró ninguna traducción
optionsTranslateOptions<Locales>Opciones adicionales para traducción

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, si no se encuentra ninguna traducción, devuelve un mensaje por defecto.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Sobre detalles de las opciones, ver TranslateOptions.

Firma de Llamada

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

Traducción de mensaje local para interpolaciones de lista

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, los mensajes locales deben contener {0}, {1}, ... para cada marcador de posición en la lista.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para interpolaciones de lista y plurales

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista
pluralnumberQué cadena plural obtener. 1 devuelve la primera.

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, los mensajes locales deben contener {0}, {1}, ... para cada marcador de posición en la lista, y devuelve un mensaje de traducción pluralizado.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para interpolaciones de lista y mensaje por defecto faltante

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista
defaultMsgstringUn mensaje por defecto a devolver si no se encontró ninguna traducción

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

Ver sobre:

En esta sobrecarga t, los mensajes locales deben contener {0}, {1}, ... para cada marcador de posición en la lista, y si no se encuentra ninguna traducción, devuelve un mensaje por defecto.

Firma de Llamada

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

Traducción de mensaje local para interpolaciones de lista

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista
optionsTranslateOptions<Locales>Opciones adicionales para traducción

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, los mensajes locales deben contener {0}, {1}, ... para cada marcador de posición en la lista.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Sobre detalles de las opciones, ver TranslateOptions.

Cómo usar en detalle:

Firma de Llamada

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

Traducción de mensaje local para interpolaciones con nombre

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, para cada marcador de posición x, los mensajes locales deben contener un token {x}.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para interpolaciones con nombre y plurales

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre
pluralnumberQué cadena plural obtener. 1 devuelve la primera.

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, para cada marcador de posición x, los mensajes locales deben contener un token {x}, y devuelve un mensaje de traducción pluralizado.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para interpolaciones con nombre y plurales

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre
defaultMsgstringUn mensaje por defecto a devolver si no se encontró ninguna traducción

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, para cada marcador de posición x, los mensajes locales deben contener un token {x}, y si no se encuentra ninguna traducción, devuelve un mensaje por defecto.

Ver sobre:

Firma de Llamada

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

Traducción de mensaje local para interpolaciones con nombre

Parámetros de Tipo

Parámetro de Tipo
Key extends string

Parámetros

ParámetroTipoDescripción
keynumber | ResourceKeys | KeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre
optionsTranslateOptions<Locales>Opciones adicionales para traducción

Devuelve

string

Mensaje traducido

Comentarios

Sobrecarga t.

En esta sobrecarga t, para cada marcador de posición x, los mensajes locales deben contener un token {x}.

También puedes suprimir la advertencia cuando falta la traducción según las opciones.

Sobre detalles de las opciones, ver TranslateOptions.

Cómo usar en detalle: