# General Translation Platform: getRegionProperties
URL: https://generaltranslation.com/es/docs/platform/core/reference/gt-class-methods/locales/get-region-properties.mdx
---

title: getRegionProperties
description: Devuelve metadatos de región para una configuración regional o un código de región. Referencia de la API de getRegionProperties.

---

Recupera detalles sobre un código de región en una instancia de [GT](/docs/platform/core/reference/gt-class/constructor), incluido su nombre localizado y el emoji flag asociado. General Translation ofrece una forma práctica de obtener información de visualización específica de la región para crear interfaces de usuario internacionalizadas.

## Resumen general [#overview]

Llama a `getRegionProperties` en una instancia de [`GT`](/docs/platform/core/reference/gt-class/constructor) con un código de región opcional. Si se omite, se usa la región de la configuración regional de destino de la instancia.

```typescript
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: 'États-Unis', emoji: '🇺🇸' }

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

// Detección automática desde la configuración regional actual
const currentRegion = gt.getRegionProperties(); // Usa la región del targetLocale
console.log(currentRegion);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }
```

Firma:

```typescript
getRegionProperties(
  region?: string,
  customMapping?: CustomRegionMapping
): { code: string; name: string; emoji: string }
```

*Nota: `getRegionProperties` se ejecuta localmente con `Intl.DisplayNames` y no requiere una API key. Usa la región del `targetLocale` de la instancia cuando se omite `region`, y localiza el nombre de la región según el `targetLocale` de la instancia. Para búsquedas sin una instancia de `GT`, consulta la versión independiente de [`getRegionProperties`](/docs/platform/core/reference/utility-functions/locales/get-region-properties).*

## Cómo funciona [#how-it-works]

* **Códigos de región.** Acepta códigos de región ISO 3166-1 alpha-2 o UN M.49 (por ejemplo, `"US"`, `"FR"`, `"419"`).
* **Nombres localizados.** Usa `Intl.DisplayNames` para localizar el nombre de la región según el `targetLocale` de la instancia, y en su defecto usa la configuración regional predeterminada de la biblioteca.
* **Prioridad del mapeo personalizado.** Si un `customMapping` proporciona un `name` o `emoji` para la región, estos reemplazan los valores predeterminados.
* **Valores de reserva.** Usa el código de región como `name` si falla la resolución del nombre para mostrar, y un emoji predeterminado si no se encuentra ningún mapeo de emoji.
* **Región de reserva.** Cuando se omite `region`, se usa la región de la configuración regional de destino de la instancia.
* **Configuración regional no disponible.** Lanza un `Error` si no hay ninguna configuración regional de destino disponible para determinar las propiedades de la región.

## Parámetros [#parameters]

| Parámetro                          | Descripción                                                                             | Type                  | Opcional | Predeterminado                          |
| ---------------------------------- | --------------------------------------------------------------------------------------- | --------------------- | -------- | --------------------------------------- |
| [`region`](#region)                | Código de región ISO 3166-1 alfa-2 o UN M.49.                                           | `string`              | Sí       | `this.getLocaleProperties().regionCode` |
| [`customMapping`](#custom-mapping) | Mapeo de regiones personalizado para sobrescribir los nombres y emojis predeterminados. | `CustomRegionMapping` | Sí       | `this.customRegionMapping`              |

### `region` [#region]

**Tipo** `string` · **Opcional** · **Valor predeterminado** `this.getLocaleProperties().regionCode`

Código de región ISO 3166-1 alfa-2 o de la ONU M.49. Si no se proporciona, se usa la región de la configuración regional de destino de la instancia.

### `customMapping` [#custom-mapping]

**Tipo** `CustomRegionMapping` · **Opcional** · **Predeterminado** `this.customRegionMapping`

Mapeo de región personalizado opcional para reemplazar los nombres y emojis predeterminados de las regiones.

## Devuelve [#returns]

**Tipo** `{ code: string; name: string; emoji: string }`

Un objeto que contiene:

* `code`: el código de la región de entrada.
* `name`: el nombre localizado (o personalizado) de la región en el idioma de la configuración regional de destino.
* `emoji`: el emoji de bandera o símbolo asociado.

## Ejemplos [#examples]

```typescript
// Información básica de 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: 'United States', emoji: '🇺🇸' }
console.log(gt.getRegionProperties('GB')); // { code: 'GB', name: 'United Kingdom', emoji: '🇬🇧' }
console.log(gt.getRegionProperties('DE')); // { code: 'DE', name: 'Germany', emoji: '🇩🇪' }
console.log(gt.getRegionProperties('JP')); // { code: 'JP', name: 'Japan', emoji: '🇯🇵' }
```

```typescript
// El mapeo de región personalizado reemplaza los valores predeterminados
const gt = new GT({ targetLocale: 'en-US' });

console.log(gt.getRegionProperties('US', { US: { name: 'USA', emoji: '🗽' } }));
// { code: 'US', name: 'USA', emoji: '🗽' }
```

## Notas [#notes]

* Usa la API `Intl.DisplayNames` para obtener nombres de regiones localizados.
* Admite tanto códigos de región ISO 3166-1 alfa-2 como códigos UN M.49.
* Los mapeos personalizados anulan los nombres y emojis predeterminados.
* Detecta automáticamente la región a partir de la configuración regional de destino si no se proporciona ningún parámetro.
* Si falla la resolución del nombre mostrado, usa el código de región como nombre.