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

title: getRegionProperties
description: Devuelve metadatos de una región sin una instancia de GT. Referencia de la API de getRegionProperties.

---

[`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) es una función de utilidad independiente de la biblioteca Core de General Translation que devuelve metadatos sobre un código de región, incluido su nombre localizado y un emoji representativo.

## Descripción general [#overview]

Importa `getRegionProperties` directamente desde `generaltranslation` y llámalo con un código de región y una configuración regional de visualización opcional. No requiere una clave de API ni una instancia de [GT](/docs/platform/core/reference/gt-class/constructor). Para la alternativa basada en instancias, usa el método [`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) de una instancia de [`GT`](/docs/platform/core/reference/gt-class/constructor).

```typescript
import { getRegionProperties } from 'generaltranslation';

console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }
```

Firma:

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

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

* **Nombres localizados.** Usa la API `Intl.DisplayNames` para generar nombres de regiones localizados según `defaultLocale`.
* **Códigos de región.** Admite códigos de región ISO 3166-1 alpha-2 y UN M.49.
* **Mapeo personalizado.** Un `CustomRegionMapping` puede reemplazar los nombres y emojis predeterminados.
* **Contenido alternativo.** Si falla la resolución del nombre para mostrar, usa el código de región.

## Parámetros [#parameters]

| Parámetro                          | Descripción                                                             | Tipo                  | Opcional | Predeterminado |
| ---------------------------------- | ----------------------------------------------------------------------- | --------------------- | -------- | -------------- |
| [`region`](#region)                | Código de región cuyas propiedades se quieren obtener.                  | `string`              | No       | —              |
| [`defaultLocale`](#default-locale) | Configuración regional utilizada para localizar el nombre de la región. | `string`              | Sí       | `en`           |
| [`customMapping`](#custom-mapping) | Mapeo personalizado para códigos, nombres y emojis de región.           | `CustomRegionMapping` | Sí       | —              |

### `region` [#region]

**Tipo** `string` · **Obligatorio**

El código de región del que se obtendrán las propiedades (ISO 3166-1 alpha-2 o UN M.49).

### `defaultLocale` [#default-locale]

**Tipo** `string` · **Opcional** · **Predeterminado** `en`

La configuración regional que se utiliza para localizar el nombre de la región devuelta.

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

**Tipo** `CustomRegionMapping` · **Opcional**

Un mapeo personalizado opcional para los códigos de región, que puede reemplazar los nombres y emojis predeterminados.

## Devuelve [#returns]

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

Un objeto con información de la región, incluido el código de la región, el nombre localizado y el emoji.

## Ejemplos [#examples]

```typescript
import { getRegionProperties } from 'generaltranslation';

// Propiedades de región con nombres en inglés
console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

console.log(getRegionProperties('JP', 'en-US'));
// { code: 'JP', name: 'Japan', emoji: '🇯🇵' }

// Propiedades de región con nombres localizados
console.log(getRegionProperties('US', 'de-DE'));
// { code: 'US', name: 'Vereinigte Staaten', emoji: '🇺🇸' }
```

## Notas [#notes]

* Usa la API `Intl.DisplayNames` para obtener nombres de regiones localizados.
* Admite códigos de región ISO 3166-1 alfa-2 y UN M.49.
* Los mapeos personalizados pueden reemplazar los nombres y emojis predeterminados.
* Recurre al código de región si no se puede obtener el nombre para mostrar.
* No tiene dependencias externas más allá de las API del navegador.