# gt-node: General Translation Node.js SDK: getLocaleProperties
URL: https://generaltranslation.com/es/docs/node/reference/functions/get-locale-properties.mdx
---

title: getLocaleProperties
description: Lee los metadatos de presentación de una configuración regional en General Translation gt-node. Referencia de la API de getLocaleProperties.

---

Devuelve metadatos sobre una configuración regional: su nombre, nombre nativo, idioma, región e información sobre el sistema de escritura. Úsalo para crear selectores de configuración regional o para mostrar a los usuarios los metadatos de la configuración regional.

## Descripción general [#overview]

Llama a `getLocaleProperties` con un código de configuración regional o sin argumentos para usar la configuración regional actual. Devuelve un objeto [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties).

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

const props = getLocaleProperties('en-US');
console.log(props.name); // 'American English'
```

Firma:

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

*Nota: Esta función es sincrónica; no hace falta usar `await`.*

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

* **Contenido alternativo de la configuración regional.** Si se omite `locale`, se refiere a la configuración regional actual.
* **Subetiquetas derivadas.** Resuelve las subetiquetas de idioma, escritura y región, así como sus nombres para mostrar y las formas maximizadas.
* **Sincrónico.** Devuelve el resultado de inmediato y no requiere ninguna solicitud de red.

## Parámetros [#parameters]

| Parámetro           | Descripción                                                    | Tipo     | Opcional | Predeterminado                |
| ------------------- | -------------------------------------------------------------- | -------- | -------- | ----------------------------- |
| [`locale`](#locale) | Código de configuración regional BCP 47 que se va a describir. | `string` | Sí       | Configuración regional actual |

### `locale` [#locale]

**Tipo** `string` · **Opcional** · **Predeterminado** Configuración regional actual

Un código de configuración regional BCP 47 (por ejemplo, `'en-US'`, `'ja'`). Si no se especifica, se usa la configuración regional actual.

## Devuelve [#returns]

**Tipo** `LocaleProperties`

Un objeto `LocaleProperties` con los siguientes campos:

| Campo                      | Tipo     | Descripción                                                                                              |
| -------------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `code`                     | `string` | El código de configuración regional (por ejemplo, `'en-US'`).                                            |
| `name`                     | `string` | El nombre en inglés de la configuración regional (por ejemplo, `'American English'`).                    |
| `nativeName`               | `string` | El nombre de la configuración regional en su propio idioma (por ejemplo, `'American English'`).          |
| `languageCode`             | `string` | La subetiqueta de idioma (por ejemplo, `'en'`).                                                          |
| `languageName`             | `string` | El nombre en inglés del idioma (por ejemplo, `'English'`).                                               |
| `nativeLanguageName`       | `string` | El nombre del idioma en su propio idioma (por ejemplo, `'English'`).                                     |
| `nameWithRegionCode`       | `string` | El nombre de la configuración regional, incluido el código de región (por ejemplo, `'English (US)'`).    |
| `nativeNameWithRegionCode` | `string` | El nombre nativo de la configuración regional, incluido el código de región.                             |
| `regionCode`               | `string` | La subetiqueta de región (por ejemplo, `'US'`).                                                          |
| `regionName`               | `string` | El nombre en inglés de la región (por ejemplo, `'United States'`).                                       |
| `nativeRegionName`         | `string` | El nombre de la región en el propio idioma de la configuración regional.                                 |
| `scriptCode`               | `string` | La subetiqueta de sistema de escritura (por ejemplo, `'Latn'`).                                          |
| `scriptName`               | `string` | El nombre en inglés del sistema de escritura (por ejemplo, `'Latin'`).                                   |
| `nativeScriptName`         | `string` | El nombre del sistema de escritura en el propio idioma de la configuración regional.                     |
| `maximizedCode`            | `string` | El código de configuración regional totalmente expandido (por ejemplo, `'en-Latn-US'`).                  |
| `maximizedName`            | `string` | El nombre en inglés de la configuración regional maximizada (por ejemplo, `'American English (Latin)'`). |
| `nativeMaximizedName`      | `string` | El nombre de la configuración regional maximizada en su propio idioma.                                   |
| `minimizedCode`            | `string` | El código de configuración regional mínimo (por ejemplo, `'en'`).                                        |
| `minimizedName`            | `string` | El nombre en inglés de la configuración regional minimizada.                                             |
| `nativeMinimizedName`      | `string` | El nombre de la configuración regional minimizada en su propio idioma.                                   |
| `emoji`                    | `string` | Un emoji de bandera o un emoji representativo de la configuración regional.                              |

## Ejemplos [#examples]

```ts title="handler.js"
// Uso básico
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 [#notes]

* Esta función es síncrona; no es necesario usar `await`.
* Útil para crear selectores de configuración regional o mostrar a los usuarios los metadatos de la configuración regional.