# General Translation Platform: getLocaleName
URL: https://generaltranslation.com/fr/docs/platform/core/reference/gt-class-methods/locales/get-locale-name.mdx
---

title: getLocaleName
description: Retourne un nom de paramètre régional compréhensible. Référence de l’API pour getLocaleName.

---

Récupère le nom d’affichage d’un code de langue dans une instance de [GT](/docs/platform/core/reference/gt-class/constructor), à l’aide de l’API `Intl.DisplayNames`. General Translation retourne un nom compréhensible pour tout code de langue BCP-47 valide, localisé selon le paramètre régional source de l’instance.

## Vue d’ensemble [#overview]

Appelez `getLocaleName` sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor) avec un code de langue facultatif. Si aucun n’est fourni, la méthode utilise le `targetLocale` de l’instance.

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

const name = gt.getLocaleName('fr-CA');
console.log(name); // "Canadian French"
```

Signature :

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

*Remarque : `getLocaleName` s’exécute localement à l’aide de `Intl.DisplayNames` et ne nécessite pas de clé d’API. Il utilise le `targetLocale` de l’instance lorsque `locale` est omis. Pour effectuer des recherches sans instance `GT`, consultez la fonction autonome [`getLocaleName`](/docs/platform/core/reference/utility-functions/locales/get-locale-name).*

## Fonctionnement [#how-it-works]

### Langue d’affichage

Le nom d’affichage est localisé en fonction de :

1. `sourceLocale` de l’instance (s’il est configuré).
2. Le paramètre régional par défaut de la bibliothèque (`'en'`).

### Intégration du mappage personnalisé

* Les mappages personnalisés de paramètres régionaux sont vérifiés en premier.
* Si un nom personnalisé est défini, il est prioritaire.
* Sinon, le système utilise `Intl.DisplayNames` pour les codes BCP-47 standard.

### Paramètre régional manquant

Lève une `Error` si aucun paramètre régional n’est fourni et que l’instance n’a pas de `targetLocale` configuré. Renvoie une chaîne vide si aucun nom n’est associé à un paramètre régional valide.

## Paramètres [#parameters]

| Paramètre           | Description                                                   | Type     | Facultatif | Par défaut          |
| ------------------- | ------------------------------------------------------------- | -------- | ---------- | ------------------- |
| [`locale`](#locale) | Code de langue BCP-47 pour lequel obtenir le nom d’affichage. | `string` | Oui        | `this.targetLocale` |

### `locale` [#locale]

**Type** `string` · **Facultatif** · **Par défaut** `this.targetLocale`

Code de langue BCP-47 dont on veut obtenir le nom d’affichage. S’il n’est pas fourni, le `targetLocale` de l’instance est utilisé.

## Retourne [#returns]

**Type** `string`

Le nom d’affichage localisé du paramètre régional. Lève une `Error` si aucun paramètre régional n’est fourni et qu’aucun `targetLocale` n’est configuré pour l’instance.

## Exemples [#examples]

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

// Obtenir le nom du paramètre régional cible
console.log(gt.getLocaleName()); // "French"

// Obtenir les noms des autres paramètres régionaux
console.log(gt.getLocaleName('es')); // "Spanish"
console.log(gt.getLocaleName('de')); // "German"
console.log(gt.getLocaleName('ja')); // "Japanese"
```

## Notes [#notes]

* La méthode utilise le `sourceLocale` de l’instance pour déterminer la langue d’affichage.
* Les noms définis dans le mappage personnalisé priment sur ceux de `Intl.DisplayNames`.