# generaltranslation: General Translation Core SDK: getLocaleProperties
URL: https://generaltranslation.com/es/docs/core/functions/locales/get-locale-properties.mdx
---
title: getLocaleProperties
description: Referencia de la API para la función autónoma getLocaleProperties
---

## Descripción general

La función autónoma `getLocaleProperties` obtiene las propiedades de un código de configuración regional sin requerir una instancia de la clase GT.
Proporciona información detallada, incluidos nombres para mostrar, códigos de región, sistema de escritura y banderas de emoji, en un objeto `LocaleProperties` completo.

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

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

***


## Referencia

### Parámetros

<TypeTable
  type={{
  "locale": {
    type: 'string',
    optional: false,
  },
  "defaultLocale?": {
    type: 'string',
    optional: true,
  },
  "customMapping?": {
    type: 'CustomMapping',
    optional: true,
  }
}}
/>

### Descripción de los parámetros

| Parámetro       | Descripción                                                                                                     |
| --------------- | --------------------------------------------------------------------------------------------------------------- |
| `locale`        | código de configuración regional BCP-47 del que se obtendrán las propiedades                                    |
| `defaultLocale` | Configuración regional que se usará para localizar los nombres para mostrar (el valor predeterminado es `'en'`) |
| `customMapping` | Mapeo personalizado opcional para códigos de configuración regional y propiedades                          |

### Devuelve

`LocaleProperties`: 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

***

## Funcionamiento

### Integración con mapeo personalizado

* Los mapeos personalizados se verifican primero para todas las propiedades
* Admite la resolución de alias y la sobrescritura de propiedades
* Recurre a las API estándar de Intl para los códigos no mapeados
* Resolución de la configuración regional estándar para configuraciones regionales con alias

***

## Ejemplos

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

// Nombres en inglés
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Spanish (Mexico)"
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 (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 (México)"
console.log(frProps.nativeName); // "español (México)"
```

***


## Notas

* La función proporciona datos de configuración regional sin necesidad de instanciar la clase GT
* Las propiedades de mapeo personalizado tienen prioridad sobre las API estándar de Intl
* Siempre se devuelve la interfaz `LocaleProperties` completa
* Los nombres nativos siempre se calculan en la propia configuración regional de destino

## Siguientes pasos

* Explora la [interfaz `LocaleProperties`](/docs/core/types/locale-properties): documentación completa de la interfaz
* Usa el método [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties) de la clase GT
* Obtén nombres simples de configuraciones regionales con [`getLocaleName`](/docs/core/functions/locales/get-locale-name)
* Obtén el emoji de la configuración regional con [`getLocaleEmoji`](/docs/core/functions/locales/get-locale-emoji)