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

title: getLocaleProperties
description: Devuelve propiedades detalladas de idioma, sistema de escritura, región y dirección para una configuración regional. Referencia de la API de getLocaleProperties.

---

Recupera propiedades completas de un código de configuración regional en una instancia de [GT](/docs/platform/core/reference/gt-class/constructor), incluidos nombres de visualización, información sobre el idioma, el sistema de escritura y la región, además de una bandera emoji. General Translation devuelve un objeto [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties) completo con los datos necesarios para crear interfaces de usuario internacionalizadas avanzadas.

## Descripción general [#overview]

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

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

const props = gt.getLocaleProperties('fr-CA');
console.log(props.name); // "Canadian French"
console.log(props.nativeName); // "français canadien"
console.log(props.emoji); // "🇨🇦"
```

Firma:

```typescript
getLocaleProperties(locale?: string): LocaleProperties
```

*Nota: `getLocaleProperties` se ejecuta localmente y no requiere una clave de API. Usa el `targetLocale` de la instancia cuando se omite `locale` y respeta el `sourceLocale` de la instancia para los nombres de visualización. Para búsquedas sin una instancia de `GT`, consulta la versión independiente de [`getLocaleProperties`](/docs/platform/core/reference/utility-functions/locales/get-locale-properties).*

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

* **Formas maximizada y minimizada.** El método obtiene tanto una forma maximizada (con el sistema de escritura y la región más probables añadidos) como una forma minimizada del código de configuración regional.
* **Idioma de visualización.** Todos los nombres de visualización respetan la configuración `sourceLocale` de la instancia.
* **Prioridad de mapeo personalizado.** Las propiedades definidas en un [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) tienen prioridad sobre las API estándar de `Intl`.
* **Configuración regional predeterminada.** Cuando se omite `locale`, se usa el `targetLocale` de la instancia.
* **Falta la configuración regional.** Lanza un `Error` si no se proporciona ninguna configuración regional y la instancia no tiene ningún `targetLocale` configurado.

## Parámetros [#parameters]

| Parámetro           | Descripción                                                                   | Tipo     | Opcional | Predeterminado      |
| ------------------- | ----------------------------------------------------------------------------- | -------- | -------- | ------------------- |
| [`locale`](#locale) | Código de configuración regional BCP-47 del que se obtendrán las propiedades. | `string` | Sí       | `this.targetLocale` |

### `locale` [#locale]

**Tipo** `string` · **Opcional** · **Por defecto** `this.targetLocale`

Código de configuración regional BCP-47 para obtener las propiedades (por ejemplo, `"de-AT"`). Si no se proporciona, se usa el `targetLocale` de la instancia.

## Returns [#returns]

**Type** [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties)

Un objeto completo que describe la configuración regional:

* `code`: el código completo de configuración regional (por ejemplo, `"de-AT"`).
* `name`: nombre del idioma en el idioma de visualización (por ejemplo, `"Austrian German"`).
* `nativeName`: nombre del idioma en el idioma nativo de la configuración regional (por ejemplo, `"Österreichisches Deutsch"`).
* `languageCode`, `languageName`, `nativeLanguageName`: información del idioma base.
* `nameWithRegionCode`, `nativeNameWithRegionCode`: nombre del idioma con código de región (por ejemplo, `"German (AT)"`).
* `regionCode`, `regionName`, `nativeRegionName`: información de la región.
* `scriptCode`, `scriptName`, `nativeScriptName`: información del sistema de escritura.
* `maximizedCode`, `maximizedName`, `nativeMaximizedName`: formas maximizadas con sistema de escritura y región probables.
* `minimizedCode`, `minimizedName`, `nativeMinimizedName`: formas minimizadas.
* `emoji`: la bandera o el emoji representativo de la región de la configuración regional.

Lanza un `Error` si no se proporciona ninguna configuración regional y la instancia no tiene `targetLocale` configurado.

## Ejemplos [#examples]

```typescript
// Uso básico
const gt = new GT({ sourceLocale: 'en', targetLocale: 'fr' });

// Obtener propiedades para la configuración regional de destino
const props = gt.getLocaleProperties();
console.log(props.name); // "French"
console.log(props.nativeName); // "français"
console.log(props.languageCode); // "fr"
console.log(props.regionCode); // "FR"
console.log(props.emoji); // "🇫🇷"

// Obtener propiedades para otras configuraciones regionales
const germanProps = gt.getLocaleProperties('de-AT');
console.log(germanProps.name); // "Austrian German"
console.log(germanProps.nativeName); // "Österreichisches Deutsch"
console.log(germanProps.regionName); // "Austria"
console.log(germanProps.nativeRegionName); // "Österreich"
```

## Notas [#notes]

* Todos los nombres de visualización respetan la configuración `sourceLocale` de la instancia.
* Las propiedades de mapeo personalizado tienen prioridad sobre las API estándar de `Intl`.