# node: getLocaleProperties
URL: https://generaltranslation.com/es/docs/node/api/get-locale-properties.mdx
---
title: getLocaleProperties
description: Referencia de la API de la función getLocaleProperties
---

## Resumen

La función `getLocaleProperties` devuelve metadatos sobre una configuración regional especificada, como su nombre, nombre nativo, idioma, región e información de la escritura.

```js
import { getLocaleProperties } from 'gt-node';

const props = getLocaleProperties('en-US');
console.log(props.name); // 'inglés americano'
```


## Referencia

### Parámetros

| Parámetro | Tipo     | Descripción                                                                                                                         |
| --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `locale`  | `string` | Un código de configuración regional BCP 47 (p. ej., `'en-US'`, `'ja'`). Si no se proporciona, usa la configuración regional actual. |

### Devuelve

Un objeto `LocaleProperties` con los siguientes campos:

| Campo                      | Tipo     | Descripción                                                                              |
| -------------------------- | -------- | ---------------------------------------------------------------------------------------- |
| `code`                     | `string` | El código de la configuración regional (p. ej., `'en-US'`).                              |
| `name`                     | `string` | El nombre en inglés de la configuración regional (p. ej., `'American English'`).         |
| `nativeName`               | `string` | El nombre en el idioma de la configuración regional (p. ej., `'American English'`).      |
| `languageCode`             | `string` | La subetiqueta de idioma (p. ej., `'en'`).                                               |
| `languageName`             | `string` | El nombre en inglés del idioma (p. ej., `'English'`).                                    |
| `nativeLanguageName`       | `string` | El nombre del idioma en su propio idioma (p. ej., `'English'`).                          |
| `nameWithRegionCode`       | `string` | El nombre de la configuración regional, incluida la región (p. ej., `'English (US)'`).   |
| `nativeNameWithRegionCode` | `string` | El nombre nativo de la configuración regional, incluida la región.                       |
| `regionCode`               | `string` | La subetiqueta de región (p. ej., `'US'`).                                               |
| `regionName`               | `string` | El nombre en inglés de la región (p. ej., `'United States'`).                            |
| `nativeRegionName`         | `string` | El nombre de la región en el idioma de la configuración regional.                        |
| `scriptCode`               | `string` | La subetiqueta del sistema de escritura (p. ej., `'Latn'`).                              |
| `scriptName`               | `string` | El nombre en inglés del sistema de escritura (p. ej., `'Latin'`).                        |
| `nativeScriptName`         | `string` | El nombre del sistema de escritura en el idioma de la configuración regional.            |
| `maximizedCode`            | `string` | El código de la configuración regional completamente expandido (p. ej., `'en-Latn-US'`). |

***

## Ejemplos

### Uso básico

```js title="handler.js"
import { getLocaleProperties } from 'gt-node';

app.get('/api/locale-info', (req, res) => {
  const props = getLocaleProperties('ja');
  res.json({
    name: props.name,           // 'Japanese'
    nativeName: props.nativeName, // '日本語'
    script: props.scriptName,   // 'Japanese'
  });
});
```

***


## Notas

* Esta función es sincrónica; no necesitas usar `await`.
* Es útil para crear selectores de configuración regional o mostrar metadatos de la configuración regional a los usuarios.

## Siguientes pasos

* Consulta [`getLocale`](/docs/node/api/get-locale) para conocer la configuración regional actual de la solicitud.
* Obtén más información sobre los [códigos de configuración regional](/docs/core/locales).