API Heredada

Choice

Firma:

export type Choice = number;

DESAPROBADO

será eliminado en vue-i18n v12

DateTimeFormatResult

Firma:

export type DateTimeFormatResult = string;

DESAPROBADO

será eliminado en vue-i18n v12

LocaleMessageObject

Firma:

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

DESAPROBADO

será eliminado en vue-i18n v12

NumberFormatResult

Firma:

export type NumberFormatResult = string;

DESAPROBADO

será eliminado en vue-i18n v12

PluralizationRulesMap

Firma:

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

DESAPROBADO

será eliminado en vue-i18n v12

TranslateResult

Firma:

export type TranslateResult = string;

DESAPROBADO

será eliminado en vue-i18n v12

VueI18n

Interfaces heredadas de VueI18n

Firma:

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>>

DESAPROBADO

será eliminado en vue-i18n v12

Detalles

Esta interfaz es compatible con la interfaz de la clase VueI18n (ofrecida con Vue I18n v8.x).

availableLocales

Firma:

readonly availableLocales: Composition['availableLocales'];

Detalles

La lista de locales disponibles en messages en orden léxico.

d

Formato de fecha y hora

Firma:

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

Detalles

Para obtener más detalles sobre funciones, consulta VueI18nDateTimeFormatting

datetimeFormats

Firma:

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

Detalles

Los formatos de fecha y hora de localización.

Ver también

• Formato de fecha y hora

escapeParameterHtml

Firma:

escapeParameterHtml: Composition['escapeParameter'];

Detalles

Si se escapan los parámetros de interpolación antes de que se traduzca el mensaje.

Ver también

• Mensaje HTML

fallbackLocale

Firma:

fallbackLocale: FallbackLocales<Locales>;

Detalles

Los locales de reserva actuales que está utilizando esta instancia de VueI18n.

Ver también

• Reserva

formatFallbackMessages

Firma:

formatFallbackMessages: Composition['fallbackFormat'];

Detalles

Si suprime las advertencias cuando se hace reserva a fallbackLocale o raíz.

Ver también

• Reserva

getDateTimeFormat

Obtener formato de fecha y hora

Firma:

getDateTimeFormat: Composition['getDateTimeFormat'];

Detalles

obtener formato de fecha y hora desde la instancia VueI18n datetimeFormats.

getLocaleMessage

Obtener mensaje de localización

Firma:

getLocaleMessage: Composition['getLocaleMessage'];

Detalles

obtener mensaje de localización desde la instancia VueI18n messages.

getNumberFormat

Obtener formato numérico

Firma:

getNumberFormat: Composition['getNumberFormat'];

Detalles

obtener formato numérico desde la instancia VueI18n numberFormats.

id

Firma:

id: number;

Detalles

ID de instancia.

locale

Firma:

locale: Locales;

Detalles

El locale actual que está usando esta instancia de VueI18n.

Si el locale contiene un territorio y un dialecto, este locale contiene una reserva implícita.

Ver también

• Ámbito y cambio de locale

mergeDateTimeFormat

Combinar formato de fecha y hora

Firma:

mergeDateTimeFormat: Composition['mergeDateTimeFormat'];

Detalles

Combinar formato de fecha y hora a la instancia VueI18n datetimeFormats.

mergeLocaleMessage

Combinar mensaje de localización

Firma:

mergeLocaleMessage: Composition['mergeLocaleMessage'];

Detalles

Combinar mensaje de localización a la instancia VueI18n messages.

mergeNumberFormat

Combinar formato numérico

Firma:

mergeNumberFormat: Composition['mergeNumberFormat'];

Detalles

Combinar formato numérico a la instancia VueI18n numberFormats.

messages

Firma:

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

Detalles

Los mensajes de localización.

Ver también

• Cómo empezar

missing

Firma:

missing: MissingHandler | null;

Detalles

Un manejador para falta de localización.

modifiers

Firma:

readonly modifiers: Composition['modifiers'];

Detalles

Modificadores personalizados para mensajes vinculados.

Ver también

• Modificadores personalizados

n

Formato numérico

Firma:

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

Detalles

Para obtener más detalles sobre funciones, consulta VueI18nNumberFormatting

numberFormats

Firma:

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

Detalles

Los formatos numéricos de localización.

Ver también

• Formato numérico

pluralizationRules

Un conjunto de reglas para pluralización de palabras

Firma:

pluralizationRules: Composition['pluralRules'];

Ver también

• Pluralización personalizada

postTranslation

Firma:

postTranslation: PostTranslationHandler<VueMessageType> | null;

Detalles

Un manejador para procesamiento posterior de traducción.

rt

Resolver traducción de mensaje de localización

Firma:

rt: VueI18nResolveLocaleMessageTranslation<Locales>;

Detalles

Para obtener más detalles sobre funciones, consulta VueI18nResolveLocaleMessageTranslation

setDateTimeFormat

Establecer formato de fecha y hora

Firma:

setDateTimeFormat: Composition['setDateTimeFormat'];

Detalles

Establecer formato de fecha y hora a la instancia VueI18n datetimeFormats.

setLocaleMessage

Establecer mensaje de localización

Firma:

setLocaleMessage: Composition['setLocaleMessage'];

Detalles

Establecer mensaje de localización a la instancia VueI18n messages.

setNumberFormat

Establecer formato numérico

Firma:

setNumberFormat: Composition['setNumberFormat'];

Detalles

Establecer formato numérico a la instancia VueI18n numberFormats.

silentFallbackWarn

Firma:

silentFallbackWarn: Composition['fallbackWarn'];

Detalles

Si suprimir advertencias de reserva cuando falla la localización.

silentTranslationWarn

Firma:

silentTranslationWarn: Composition['missingWarn'];

Detalles

Si suprimir advertencias mostradas cuando falla la localización.

Ver también

• Reserva

sync

Firma:

sync: Composition['inheritLocale'];

Detalles

Si sincronizar el locale de nivel raíz al locale de localización del componente.

Ver también

• Ámbito local

t

Traducción de mensaje de localización

Firma:

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

Detalles

Para obtener más detalles sobre funciones, consulta VueI18nTranslation

tm

Obtener mensajes de localización

Firma:

tm: Composition['tm'];

Detalles

Si opciones del componente i18n está especificado, se obtienen primero los mensajes de localización del ámbito local en lugar de los mensajes globales.

Si opciones del componente i18n no está especificado, se obtiene con los mensajes globales de localización.

Basado en el locale actual, los mensajes de localización serán devueltos desde los mensajes de la instancia Composer.

Si cambias el locale, los mensajes de localización devueltos también corresponderán al locale.

Si no hay mensajes de localización para la key dada en los mensajes de la instancia Composer, serán devueltos con reserva.

WARNING

Necesitas usar rt para el mensaje de localización devuelto por tm. consulta los detalles de rt.

Ejemplos

plantilla:

<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

Firma:

warnHtmlInMessage: WarnHtmlInMessageLevel;

Detalles

Si permitir usar mensajes de localización con formato HTML.

Si estableces warn o error, se comprobarán los mensajes de localización en la instancia de VueI18n.

Si especificas warn, se mostrará una advertencia en la consola.

Si especificas error se producirá un Error.

Ver también

• Mensaje HTML
• Cambiar valor por defecto de la opción warnHtmlInMessage

te(key, locale)

Existencia de mensaje de localización traducido

Firma:

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

Detalles

si existe mensaje de localización en la instancia VueI18n messages.

Si especificaste locale, comprueba los mensajes de localización del locale.

Parámetros

Parámetro	Tipo	Descripción
key	Str | Key	Una clave de mensaje de localización de destino
locale	Locales	Un locale de destino

Devoluciones

Si encuentra mensaje de localización, true, sino false

VueI18nDateTimeFormatting

Funciones de formato de fecha y hora para interfaces heredadas de VueI18n

Firma:

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>

DESAPROBADO

será eliminado en vue-i18n v12

Detalles

Esta es la interfaz para VueI18n

(value: number | Date): DateTimeFormatResult;

Formato de fecha y hora

Firma:

(value: number | Date): DateTimeFormatResult;

Detalles

Si se usa en un contexto reactivo, se volverá a evaluar una vez que cambie el locale.

Si opciones del componente i18n está especificado, se formatea preferentemente con los formatos de fecha y hora del ámbito local en lugar de los mensajes de localización globales.

Si opciones del componente i18n no está especificado, se formatea con formatos de fecha y hora globales.

Ver también

• Formato de fecha y hora

Parámetros

Parámetro	Tipo	Descripción
value	number | Date	Un valor, número de marca de tiempo o instancia Date

Devoluciones

Valor formateado

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

Formato de fecha y hora

Firma:

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

Detalles

Sobrecarga de d. Para más detalles, consulta los detalles de firma de llamada.

Parámetros

Parámetro	Tipo	Descripción
value	Value	Un valor, número de marca de tiempo o instancia Date
key	Key | ResourceKeys	Una clave de formatos de fecha y hora

Devoluciones

Valor formateado

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

Formato de fecha y hora

Firma:

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

Detalles

Sobrecarga de d. Para más detalles, consulta los detalles de firma de llamada.

Parámetros

Parámetro	Tipo	Descripción
value	Value	Un valor, número de marca de tiempo o instancia Date
key	Key | ResourceKeys	Una clave de formatos de fecha y hora
locale	Locales	Un locale, se usará sobre el ámbito global o local.

Devoluciones

Valor formateado

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

Formato de fecha y hora

Firma:

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

Detalles

Sobrecarga de d. Para más detalles, consulta los detalles de firma de llamada.

Parámetros

Parámetro	Tipo	Descripción
value	number | Date	Un valor, número de marca de tiempo o instancia Date
args	{ [key: string]: string | boolean | number; }	Valores de argumentos

Devoluciones

Valor formateado

VueI18nNumberFormatting

Funciones de formato numérico para interfaces heredadas de VueI18n

Firma:

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>

DESAPROBADO

será eliminado en vue-i18n v12

Detalles

Esta es la interfaz para VueI18n

(value: number): NumberFormatResult;

Formato numérico

Firma:

(value: number): NumberFormatResult;

Detalles

Si se usa en un contexto reactivo, se volverá a evaluar una vez que cambie el locale.

Si opciones del componente i18n está especificado, se formatea preferentemente con los formatos numéricos del ámbito local en lugar de los mensajes de localización globales.

Si opciones del componente i18n no está especificado, se formatea con formatos numéricos globales.

Ver también

• Formato numérico

Parámetros

Parámetro	Tipo	Descripción
value	number	Un valor numérico

Devoluciones

Valor formateado

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

Formato numérico

Firma:

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

Detalles

Sobrecarga de n. Para más detalles, consulta los detalles de firma de llamada.

Parámetros

Parámetro	Tipo	Descripción
value	number	Un valor numérico
key	Key | ResourceKeys	Una clave de formatos numéricos

Devoluciones

Valor formateado

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

Formato numérico

Firma:

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

Detalles

Sobrecarga de n. Para más detalles, consulta los detalles de firma de llamada.

Parámetros

Parámetro	Tipo	Descripción
value	number	Un valor numérico
key	Key | ResourceKeys	Una clave de formatos numéricos
locale	Locales	Un locale, se usará sobre el ámbito global o local.

Devoluciones

Valor formateado

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

Formato numérico

Firma:

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

Detalles

Sobrecarga de n. Para más detalles, consulta los detalles de firma de llamada.

Parámetros

Parámetro	Tipo	Descripción
value	number	Un valor numérico
args	{ [key: string]: string | boolean | number; }	Valores de argumentos

Devoluciones

Valor formateado

VueI18nOptions

Opciones de VueI18n

Firma:

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>>

DESAPROBADO

será eliminado en vue-i18n v12

Detalles

Esta opción es compatible con las opciones del constructor de la clase VueI18n (ofrecidas con Vue I18n v8.x)

availableLocales

Firma:

availableLocales?: Locale[];

Detalles

La lista de locales disponibles en los mensajes en orden léxico.

Valor por defecto

[]

datetime

datetimeFormats

escapeParameterHtml

Firma:

escapeParameterHtml?: Options['escapeParameter'];

Detalles

Si escapar los parámetros para valores de interpolación de lista o de nombre. Cuando se habilita, esta opción: - Escapa caracteres especiales de HTML (<, >, ", ', &, /, =) en parámetros de interpolación - Sanitiza el HTML traducido final para prevenir ataques XSS mediante: - Escapando caracteres peligrosos en valores de atributos HTML - Neutralizando atributos de controladores de eventos (onclick, onerror, etc.) - Deshabilitando URLs javascript: en atributos href, src, action, formaction y style

Esto es útil cuando la salida de traducción se usa en v-html y el recurso de traducción contiene marcado HTML (por ejemplo, rodeado de un valor proporcionado por el usuario).

Este patrón de uso ocurre principalmente al pasar cadenas de texto precalculadas a componentes de UI.

El proceso de escape implica reemplazar los siguientes símbolos con sus respectivas entidades de carácter HTML: <, >, ", '.

Configurar escapeParameterHtml como verdadero no debería romper la funcionalidad existente pero proporciona una protección contra tipos sutiles de vectores de ataque XSS.

Valor por defecto

false

Ver también

• Mensaje HTML - Usar la opción escapeParameter

fallbackLocale

Firma:

fallbackLocale?: Options['fallbackLocale'];

Detalles

El locale de reserva de localización.

Para definiciones de reserva más complejas, ve reserva.

Valor por defecto

Por defecto 'en-US' para el locale si no está especificado, o su valor locale

Ver también

• Reserva

fallbackRoot

Firma:

fallbackRoot?: Options['fallbackRoot'];

Detalles

En la localización del componente, si hacer reserva al nivel raíz (ámbito global) cuando falla la localización.

Si false, no se hace reserva a raíz.

Valor por defecto

true

Ver también

• Reserva

flatJson

Firma:

flatJson?: Options['flatJson'];

Detalles

Permitir usar mensajes JSON planos o no

Valor por defecto

false

formatFallbackMessages

Firma:

formatFallbackMessages?: Options['fallbackFormat'];

Detalles

Si suprime las advertencias cuando se hace reserva a fallbackLocale o raíz.

Valor por defecto

false

Ver también

• Reserva

locale

Firma:

locale?: Options['locale'];

Detalles

El locale de localización.

Si el locale contiene un territorio y un dialecto, este locale contiene una reserva implícita.

Valor por defecto

'en-US'

Ver también

• Ámbito y cambio de locale

message

messageResolver

Firma:

messageResolver?: MessageResolver;

Detalles

Un resolvedor de mensajes para resolver messages.

Si no se especifica, se utilizará por defecto el resolvedor interno de mensajes de vue-i18n.

Necesitas implementar tú mismo un resolvedor de mensajes que cumpla con los siguientes requisitos:

• Resuelve el mensaje usando el mensaje de localización de locale pasado como primer argumento del resolvedor de mensajes, y la ruta pasada como segundo argumento.

• Si no se puede resolver el mensaje, debes devolver null.

• Si se devuelve null, el resolvedor de mensajes también será llamado en reserva si fallbackLocale está habilitado, por lo tanto se necesita resolver también el mensaje.

El resolvedor de mensajes es llamado indirectamente por las siguientes API:

• t

• te

• tm

• Componente de traducción

TIP

🆕 v9.2+

WARNING

Si usas el resolvedor de mensajes, la configuración flatJson será ignorada. Es decir, necesitas resolver el JSON plano tú mismo.

Valor por defecto

undefined

Ver también

• Reserva

Ejemplos

Aquí tienes un ejemplo de cómo configurarlo usando tu createI18n:

import { createI18n } from 'vue-i18n'

// tu resolvedor de mensajes
function messageResolver(obj, path) {
  // ¡resolución simple de mensajes!
  const msg = obj[path]
  return msg != null ? msg : null
}

// llamada con opción I18n
const i18n = createI18n({
  locale: 'ja',
  messageResolver, // establece tu resolvedor de mensajes
  messages: {
    en: { ... },
    ja: { ... }
  }
})

// lo siguiente es algo que haces ...
// ...

messages

missing

Firma:

missing?: Options['missing'];

Detalles

Un manejador para falta de localización.

El manejador es llamado con el locale objetivo de localización, la clave de ruta de localización, la instancia de Vue y los valores.

Si se asigna un manejador de faltante y ocurre una falta de localización, no se muestra una advertencia.

Valor por defecto

null

modifiers

Firma:

modifiers?: Options['modifiers'];

Detalles

Modificadores personalizados para mensajes vinculados.

Ver también

• Modificadores personalizados

number

numberFormats

pluralizationRules

Firma:

pluralizationRules?: Options['pluralRules'];

Detalles

Un conjunto de reglas para pluralización de palabras

Valor por defecto

{}

Ver también

• Pluralización personalizada

postTranslation

Firma:

postTranslation?: Options['postTranslation'];

Detalles

Un manejador para procesamiento posterior de traducción. El manejador es llamado después de llamar con $t y t.

Este manejador es útil si quieres filtrar texto traducido, como recortar espacios.

Valor por defecto

null

sharedMessages

Firma:

sharedMessages?: LocaleMessages<VueMessageType>;

Detalles

Los mensajes de localización compartidos para componentes. Más detalles en localización basada en componentes.

Valor por defecto

undefined

Ver también

• Mensajes de localización compartidos para componentes

silentFallbackWarn

Firma:

silentFallbackWarn?: Options['fallbackWarn'];

Detalles

Si hacer interpolación de plantilla en claves de traducción cuando tu idioma carece de traducción para una clave.

Si true, salta escribir plantillas para tu idioma "base"; las claves son tus plantillas.

Valor por defecto

false

Ver también

• Reserva

silentTranslationWarn

Firma:

silentTranslationWarn?: Options['missingWarn'];

Detalles

Si suprimir advertencias mostradas cuando falla la localización.

Si true, suprime advertencias de fallo de localización.

Si usas expresión regular, puedes suprimir advertencias de fallo de localización que coincidan con la clave de traducción (por ejemplo, t).

Valor por defecto

false

Ver también

• Reserva

sync

Firma:

sync?: boolean;

Detalles

Si sincronizar el locale de nivel raíz al locale de localización del componente.

Si false, independientemente del locale de nivel raíz, localiza para cada locale de componente.

Valor por defecto

true

Ver también

• Ámbito local

warnHtmlInMessage

Firma:

warnHtmlInMessage?: WarnHtmlInMessageLevel;

Detalles

Si permitir el uso de mensajes de localización con formato HTML.

Ver la propiedad warnHtmlInMessage.

Valor por defecto

'off'

Ver también

• Mensaje HTML
• Cambiar valor por defecto de la opción warnHtmlInMessage

VueI18nResolveLocaleMessageTranslation

Funciones de resolución de traducción de mensaje de localización para interfaces heredadas de VueI18n

Firma:

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

DESAPROBADO

será eliminado en vue-i18n v12

Detalles

Esta es la interfaz para VueI18n. Esta interfaz es un alias de ComposerResolveLocaleMessageTranslation.

VueI18nTranslation

Funciones de traducción de mensaje de localización para interfaces heredadas de VueI18n

Firma:

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>

DESAPROBADO

será eliminado en vue-i18n v12

Detalles

Esta es la interfaz para VueI18n

(key: Key | ResourceKeys): TranslateResult;

Traducción de mensaje de localización.

Firma:

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

Detalles

Si se usa en un contexto reactivo, se volverá a evaluar una vez que cambie el locale.

Si opciones del componente i18n está especificado, se traduce preferentemente con los mensajes de localización del ámbito local en lugar de los mensajes globales.

Si opciones del componente i18n no está especificado, se traduce con los mensajes globales de localización.

Ver también

• Ámbito y cambio de locale

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización.

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

Ver también

• Interpolación con nombre

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
named	Record<string, unknown>	Valores de interpolación con nombre

Devoluciones

Mensaje traducido

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

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

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

Ver también

• Pluralización
• Interpolación con nombre

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
named	NamedValue	Valores de interpolación con nombre
plural	number	Qué cadena plural obtener. 1 devuelve la primera.

Devoluciones

Mensaje traducido

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

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

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

Ver también

• Interpolación con nombre

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
named	NamedValue	Valores de interpolación con nombre
defaultMsg	string	Un mensaje por defecto a devolver si no se encuentra traducción

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización para interpolaciones con nombre

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

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

Para más detalles sobre opciones, consulta .

Ver también

• Interpolación con nombre

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
named	NamedValue	Valores de interpolación con nombre
options	TranslateOptions<Locales>	Opciones adicionales para traducción

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización para plurales

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

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

Ver también

• Pluralización

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
plural	number	Qué cadena plural obtener. 1 devuelve la primera.

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización para plurales

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

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

Para más detalles sobre opciones, consulta .

Ver también

• Pluralización

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
plural	number	Qué cadena plural obtener. 1 devuelve la primera.
options	TranslateOptions<Locales>	Opciones adicionales para traducción

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización para mensaje por defecto faltante

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

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

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
defaultMsg	string	Un mensaje por defecto a devolver si no se encuentra traducción

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización para mensaje por defecto faltante

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

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

Para más detalles sobre opciones, consulta .

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
defaultMsg	string	Un mensaje por defecto a devolver si no se encuentra traducción
options	TranslateOptions<Locales>	Opciones adicionales para traducción

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización.

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

Ver también

• Interpolación de lista

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
list	unknown[]	Valores de interpolación de lista

Devoluciones

Mensaje traducido

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

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

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

Ver también

• Pluralización
• Interpolación de lista

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
list	unknown[]	Valores de interpolación de lista
plural	number	Qué cadena plural obtener. 1 devuelve la primera.

Devoluciones

Mensaje traducido

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

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

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

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

Ver también

• Interpolación de lista

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
list	unknown[]	Valores de interpolación de lista
defaultMsg	string	Un mensaje por defecto a devolver si no se encuentra traducción

Devoluciones

Mensaje traducido

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

Traducción de mensaje de localización para interpolaciones de lista

Firma:

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

Detalles

Sobrecarga de t. Para más detalles, consulta los detalles de firma de llamada.

En esta sobrecarga de t, los mensajes de localización 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.

Para más detalles sobre opciones, consulta .

Ver también

• Interpolación de lista

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de localización de destino
list	unknown[]	Valores de interpolación de lista
options	TranslateOptions<Locales>	Opciones adicionales para traducción

Devoluciones

Mensaje traducido

WarnHtmlInMessageLevel

Firma:

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

DESAPROBADO

será eliminado en vue-i18n v12