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

title: getLocaleProperties
description: Devuelve propiedades detalladas de la configuración regional sin una instancia de GT. Referencia de la API para getLocaleProperties.

---

[`getLocaleProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties) es una función utilitaria independiente de la biblioteca Core de General Translation que devuelve propiedades detalladas de un código de configuración regional, incluidos nombres para mostrar, idioma, sistema de escritura e información sobre la región, además de un emoji representativo.

## Overview [#overview]

Importa `getLocaleProperties` directamente desde `generaltranslation` y llámalo con un código de configuración regional y, opcionalmente, una configuración regional de visualización. 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 [`getLocaleProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties) de una instancia de [`GT`](/docs/platform/core/reference/gt-class/constructor).

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

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

Firma:

```typescript
getLocaleProperties(
  locale: string,
  defaultLocale?: string,
  customMapping?: CustomMapping
): LocaleProperties
```

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

* **Metadatos completos.** Devuelve el objeto [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties) completo, incluidas las formas estándar y ampliadas.
* **Nombres nativos.** Los nombres nativos siempre se calculan en la propia configuración regional de destino, independientemente de `defaultLocale`.
* **Integración con mapeos personalizados.** Los mapeos personalizados se comprueban primero para todas las propiedades, admiten la resolución de alias y la sobrescritura de propiedades, y recurren a las API estándar de `Intl` para los códigos que no estén mapeados. Las configuraciones regionales con alias se resuelven a su configuración regional canónica.

*Nota: los nombres para mostrar usan la forma dialectal de CLDR. Por ejemplo, `getLocaleProperties('es-MX', 'en').name` es "español mexicano" (no "español (México)"), y `nativeName` es "español de México".*

## Parámetros [#parameters]

| Parámetro                          | Descripción                                                                   | Tipo                                                                  | Opcional | Predeterminado |
| ---------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------- | -------------- |
| [`locale`](#locale)                | Código de configuración regional BCP-47 cuyas propiedades se quieren obtener. | `string`                                                              | No       | —              |
| [`defaultLocale`](#default-locale) | Configuración regional utilizada para localizar los nombres para mostrar.     | `string`                                                              | Sí       | `en`           |
| [`customMapping`](#custom-mapping) | Mapeo personalizado para códigos de configuración regional y propiedades.     | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Sí       | —              |

### `locale` [#locale]

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

El código de configuración regional BCP-47 del que se obtendrán las propiedades.

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

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

La configuración regional utilizada para localizar los nombres para mostrar devueltos.

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

**Tipo** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Opcional**

Un mapeo personalizado para códigos de configuración regional y propiedades.

## Devuelve [#returns]

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

Un objeto completo que contiene toda la información de la configuración regional:

* `code`: código de configuración regional estandarizado.
* `name`: nombre para mostrar en la configuración regional predeterminada.
* `nativeName`: nombre para mostrar en la propia configuración regional.
* `languageCode`, `languageName`, `nativeLanguageName`: información del idioma.
* `regionCode`, `regionName`, `nativeRegionName`: información de la región.
* `scriptCode`, `scriptName`, `nativeScriptName`: información del sistema de escritura.
* `maximizedCode`, `minimizedCode`: formas canónicas.
* `nameWithRegionCode`, `nativeNameWithRegionCode`: formatos de visualización combinados.
* `emoji`: bandera o emoji representativo.

## Ejemplos [#examples]

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

// Nombres en inglés
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Mexican Spanish"
console.log(enProps.languageName); // "Spanish"
console.log(enProps.regionName); // "Mexico"
console.log(enProps.emoji); // "🇲🇽"

// Nombres en francés
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol du Mexique"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"

// Los nombres nativos siempre están en la configuración regional de destino
console.log(enProps.nativeName); // "español de México"
console.log(frProps.nativeName); // "español de México"
```

## Notas [#notes]

* Proporciona datos de configuración regional sin instanciar la clase GT.
* Las propiedades de mapeo personalizado prevalecen sobre las API estándar de `Intl`.
* Siempre se devuelve el objeto `LocaleProperties` completo.
* Los nombres nativos siempre se calculan en la propia configuración regional de destino.