GT ClassMethodsLocales

getRegionProperties

Referencia de API del método getRegionProperties de GT

Descripción general

El método getRegionProperties recupera información detallada sobre un código de región, incluida su name localizada y la bandera de emoji asociada. Ofrece una forma práctica de obtener información de presentación específica de la región para crear interfaces de usuario internacionalizadas.

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

// Obtener propiedades de la región
const usProps = gt.getRegionProperties('US');
console.log(usProps);
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

const frProps = gt.getRegionProperties('FR');
console.log(frProps);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }

// Detectar automáticamente desde el locale actual
const currentRegion = gt.getRegionProperties(); // Usa la región de targetLocale
console.log(currentRegion);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }

Referencia

Parámetros

Prop

Type

Descripción de parámetros

ParámetroDescripción
regionCódigo de región ISO 3166-1 alfa-2 o UN M.49. Si no se proporciona, se usa la región del locale de destino de la instancia
customMappingMapeo de regiones personalizado opcional para sustituir los nombres de regiones y los emoji predeterminados

Devuelve

{ code: string; name: string; emoji: string } - Objeto que contiene:

  • code: Código de región de entrada
  • name: Nombre de la región localizado en el idioma del locale de destino
  • emoji: Bandera o símbolo de emoji asociado

Ejemplos

Información básica de la región

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

// Códigos de región comunes
console.log(gt.getRegionProperties('US')); // { code: 'US', name: 'Estados Unidos', emoji: '🇺🇸' }
console.log(gt.getRegionProperties('GB')); // { code: 'GB', name: 'Reino Unido', emoji: '🇬🇧' }
console.log(gt.getRegionProperties('DE')); // { code: 'DE', name: 'Alemania', emoji: '🇩🇪' }
console.log(gt.getRegionProperties('JP')); // { code: 'JP', name: 'Japón', emoji: '🇯🇵' }

Notas

  • Usa la API Intl.DisplayNames para nombres de región localizados
  • Compatible con códigos de región ISO 3166-1 alfa‑2 y UN M.49
  • Los mapeos personalizados reemplazan los nombres y emojis predeterminados
  • Detecta automáticamente la región a partir del locale de destino si no se proporciona ningún parámetro
  • Si no se puede resolver el nombre para mostrar, recurre al código de región como name

Próximos pasos

¿Qué te parece esta guía?