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

title: getLocaleProperties
description: Renvoie les propriétés détaillées de langue, de système d’écriture, de région et de direction d’un paramètre régional. Référence de l’API pour getLocaleProperties.

---

Récupère les propriétés complètes associées à un code de langue sur une instance de [GT](/docs/platform/core/reference/gt-class/constructor), notamment les noms d’affichage, ainsi que les informations sur la langue, le système d’écriture et la région, sans oublier un emoji de drapeau. General Translation renvoie un objet [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties) complet contenant les données nécessaires pour créer des interfaces utilisateur internationalisées riches.

## Vue d’ensemble [#overview]

Appelez `getLocaleProperties` sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor) avec un code de langue facultatif. S’il n’est pas indiqué, c’est le paramètre `targetLocale` de l’instance qui est utilisé.

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

const props = gt.getLocaleProperties('fr-CA');
console.log(props.name); // "Canadian French"
console.log(props.nativeName); // "français canadien"
console.log(props.emoji); // "🇨🇦"
```

Signature :

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

*Remarque : `getLocaleProperties` s’exécute localement et ne nécessite pas de clé API. Il utilise le `targetLocale` de l’instance lorsque `locale` est omis et se base sur le `sourceLocale` de l’instance pour les noms d’affichage. Pour effectuer des recherches sans instance `GT`, consultez la version autonome de [`getLocaleProperties`](/docs/platform/core/reference/utility-functions/locales/get-locale-properties).*

## Fonctionnement [#how-it-works]

* **Formes maximisée et minimisée.** La méthode détermine à la fois une forme maximisée (avec le système d’écriture et la région probables ajoutés) et une forme minimisée du code de langue.
* **Langue d’affichage.** Tous les noms d’affichage respectent le paramètre `sourceLocale` de l’instance.
* **Priorité du mappage personnalisé.** Les propriétés définies dans un [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) prévalent sur les API `Intl` standard.
* **Paramètre régional par défaut.** Lorsque `locale` est omis, le `targetLocale` de l’instance est utilisé.
* **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é.

## Paramètres [#parameters]

| Paramètre           | Description                                                        | Type     | Facultatif | Par défaut          |
| ------------------- | ------------------------------------------------------------------ | -------- | ---------- | ------------------- |
| [`locale`](#locale) | Code de langue BCP-47 dont les propriétés doivent être récupérées. | `string` | Oui        | `this.targetLocale` |

### `locale` [#locale]

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

Code de langue BCP-47 pour lequel obtenir les propriétés (par exemple, `"de-AT"`). S’il n’est pas fourni, le `targetLocale` de l’instance est utilisé.

## Renvoie [#returns]

**Type** [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties)

Un objet complet décrivant le paramètre régional :

* `code` : le code de langue complet (par exemple, `"de-AT"`).
* `name` : le nom de la langue dans la langue d’affichage (par exemple, `"Austrian German"`).
* `nativeName` : le nom de la langue dans la langue native du paramètre régional (par exemple, `"Österreichisches Deutsch"`).
* `languageCode`, `languageName`, `nativeLanguageName` : informations sur la langue de base.
* `nameWithRegionCode`, `nativeNameWithRegionCode` : nom de la langue avec le code de région (par exemple, `"German (AT)"`).
* `regionCode`, `regionName`, `nativeRegionName` : informations sur la région.
* `scriptCode`, `scriptName`, `nativeScriptName` : informations sur le système d’écriture.
* `maximizedCode`, `maximizedName`, `nativeMaximizedName` : formes maximisées avec système d’écriture et région probables.
* `minimizedCode`, `minimizedName`, `nativeMinimizedName` : formes minimisées.
* `emoji` : le drapeau ou l’emoji représentatif de la région du paramètre régional.

Lève une `Error` si aucun paramètre régional n’est fourni et que l’instance n’a pas de `targetLocale` configuré.

## Exemples [#examples]

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

// Récupérer les propriétés du paramètre régional cible
const props = gt.getLocaleProperties();
console.log(props.name); // "French"
console.log(props.nativeName); // "français"
console.log(props.languageCode); // "fr"
console.log(props.regionCode); // "FR"
console.log(props.emoji); // "🇫🇷"

// Récupérer les propriétés d'autres paramètres régionaux
const germanProps = gt.getLocaleProperties('de-AT');
console.log(germanProps.name); // "Austrian German"
console.log(germanProps.nativeName); // "Österreichisches Deutsch"
console.log(germanProps.regionName); // "Austria"
console.log(germanProps.nativeRegionName); // "Österreich"
```

## Notes [#notes]

* Tous les noms d’affichage respectent le paramètre `sourceLocale` de l’instance.
* Les propriétés de mappage personnalisé prévalent sur les API `Intl` standard.