GT ClassMethodsLocales

getLocaleName

Referencia de API del método getLocaleName de GT

Descripción general

El método getLocaleName obtiene el nombre visible de un código de configuración regional usando la API Intl.DisplayNames. Devuelve un nombre legible para cualquier código de configuración regional BCP-47 válido, localizado según el locale de origen de la instancia.

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

const name = gt.getLocaleName('fr-CA');
console.log(name); // "francés (Canadá)"

Referencias

Parámetros

Prop

Type

Descripción de parámetros

ParámetroDescripción
localeCódigo de configuración regional BCP-47 para obtener el nombre para mostrar. Si no se proporciona, usa el targetLocale de la instancia

Devuelve

string - El nombre localizado para mostrar del locale.

Lanza

  • Error - Si no se proporciona un locale y la instancia no tiene targetLocale configurado

Comportamiento

Idioma de visualización

El nombre visible se localiza según:

  1. El sourceLocale de la instancia (si está configurado)
  2. El locale predeterminado de la biblioteca ('en')

Integración de asignación personalizada

  • Primero se comprueban las asignaciones de locale personalizadas
  • Si se define un custom name, tiene prioridad
  • Recurre a Intl.DisplayNames para los códigos BCP-47 estándar

Ejemplos

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'fr'
});

// Obtener el nombre para el targetLocale
console.log(gt.getLocaleName()); // "Francés (Francia)"

// Obtener los nombres de otras locales
console.log(gt.getLocaleName('es')); // "Español (España)"
console.log(gt.getLocaleName('de')); // "Alemán (Alemania)"
console.log(gt.getLocaleName('ja')); // "Japonés (Japón)"

Notas

  • El método usa el sourceLocale de la instancia para determinar el idioma de visualización
  • Los nombres de asignación personalizados tienen prioridad sobre Intl.DisplayNames estándar

Próximos pasos

  • Obtén el emoji del locale con getLocaleEmoji
  • Obtén información completa del locale con getLocaleProperties
  • Aprende sobre el tipo CustomMapping](/docs/core/types/custom-mapping)

¿Qué te parece esta guía?