# General Translation Platform: getLocaleName
URL: https://generaltranslation.com/es/docs/platform/core/reference/gt-class-methods/locales/get-locale-name.mdx
---
title: getLocaleName
description: Devuelve un nombre de configuración regional legible. Referencia de la API de getLocaleName.

---

Obtiene el nombre para mostrar de un código de configuración regional en una instancia de [GT](/docs/platform/core/reference/gt-class/constructor) mediante la API `Intl.DisplayNames`. General Translation devuelve un nombre legible para cualquier código de configuración regional BCP-47 válido, localizado según la configuración regional de origen de la instancia.

## Descripción general [#overview]

Llama a `getLocaleName` 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 name = gt.getLocaleName('fr-CA');
console.log(name); // "Canadian French"
```

Firma:

```typescript
getLocaleName(locale?: string): string
```

*Nota: `getLocaleName` se ejecuta localmente con `Intl.DisplayNames` y no requiere una API key. Usa el `targetLocale` de la instancia cuando se omite `locale`. Para búsquedas sin una instancia de `GT`, consulta la versión standalone de [`getLocaleName`](/docs/platform/core/reference/utility-functions/locales/get-locale-name).*

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

### Idioma de visualización

El nombre para mostrar se localiza de acuerdo con lo siguiente:

1. La `sourceLocale` de la instancia (si está configurada).
2. La configuración regional predeterminada de la biblioteca (`'en'`).

### Integración de mapeo personalizado

* Primero se comprueban los mapeos personalizados de configuraciones regionales.
* Si se define un nombre personalizado, este tiene prioridad.
* En caso contrario, se recurre a `Intl.DisplayNames` para los códigos BCP-47 estándar.

### Configuración regional faltante

Lanza un `Error` si no se proporciona ninguna configuración regional y la instancia no tiene `targetLocale` configurado. Devuelve una cadena vacía si no se encuentra ningún nombre para una configuración regional válida.

## Parámetros [#parameters]

| Parámetro           | Descripción                                                                               | Tipo     | Opcional | Predeterminado      |
| ------------------- | ----------------------------------------------------------------------------------------- | -------- | -------- | ------------------- |
| [`locale`](#locale) | Código de configuración regional BCP-47 del que se quiere obtener el nombre para mostrar. | `string` | Sí       | `this.targetLocale` |

### `locale` [#locale]

**Tipo** `string` · **Opcional** · **Predeterminado** `this.targetLocale`

Código de configuración regional BCP-47 cuyo nombre para mostrar se quiere obtener. Si no se proporciona, se usa el `targetLocale` de la instancia.

## Devuelve [#returns]

**Tipo** `string`

El nombre para mostrar localizado de la configuración regional. Lanza un `Error` si no se proporciona una configuración regional y la instancia no tiene configurado `targetLocale`.

## Ejemplos [#examples]

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

// Obtener el nombre de la configuración regional de destino
console.log(gt.getLocaleName()); // "French"

// Obtener los nombres de otras configuraciones regionales
console.log(gt.getLocaleName('es')); // "Spanish"
console.log(gt.getLocaleName('de')); // "German"
console.log(gt.getLocaleName('ja')); // "Japanese"
```

## Notas [#notes]

* El método usa el `sourceLocale` de la instancia para determinar el idioma que se muestra.
* Los nombres de los mapeos personalizados tienen prioridad sobre los de `Intl.DisplayNames` estándar.