# General Translation Platform: getLocaleProperties
URL: https://generaltranslation.com/fr/docs/platform/core/reference/utility-functions/locales/get-locale-properties.mdx
---
title: getLocaleProperties
description: Renvoie des propriétés détaillées d’un paramètre régional sans instance GT. Référence d’API pour getLocaleProperties.

---

[`getLocaleProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties) est une fonction utilitaire autonome de la bibliothèque Core de General Translation qui renvoie des propriétés détaillées pour un code de langue, notamment les noms d’affichage, la langue, le système d’écriture, les informations sur la région, ainsi qu’un emoji représentatif.

## Vue d’ensemble [#overview]

Importez `getLocaleProperties` directement depuis `generaltranslation` et appelez-la avec un code de langue et, éventuellement, un paramètre régional d’affichage. Cela ne nécessite ni clé API ni instance de [GT](/docs/platform/core/reference/gt-class/constructor). Pour l’équivalent sous forme de méthode d’instance, utilisez plutôt la méthode [`getLocaleProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties) sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor).

```typescript
import { getLocaleProperties } from 'generaltranslation';

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

Signature :

```typescript
getLocaleProperties(
  locale: string,
  defaultLocale?: string,
  customMapping?: CustomMapping
): LocaleProperties
```

## Fonctionnement [#how-it-works]

* **Métadonnées complètes.** Renvoie l’objet [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties) complet, y compris les formes standard et maximisée.
* **Noms natifs.** Les noms natifs sont toujours calculés dans le paramètre régional cible lui-même, quelle que soit la valeur de `defaultLocale`.
* **Intégration des mappages personnalisés.** Les mappages personnalisés sont vérifiés en premier pour toutes les propriétés, prennent en charge la résolution des alias et le remplacement de propriétés, puis utilisent les API `Intl` standard comme solution de repli pour les codes non mappés. Les paramètres régionaux aliasés sont résolus vers leur paramètre régional canonique.

*Remarque : les noms d’affichage utilisent la forme dialectale du CLDR. Par exemple, `getLocaleProperties('es-MX', 'en').name` vaut "Mexican Spanish" (et non "Spanish (Mexico)"), et `nativeName` vaut "español de México".*

## Paramètres [#parameters]

| Paramètre                          | Description                                                                            | Type                                                                  | Facultatif | Par défaut |
| ---------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------- | ---------- |
| [`locale`](#locale)                | Code de langue BCP-47 pour lequel obtenir les propriétés.                              | `string`                                                              | Non        | —          |
| [`defaultLocale`](#default-locale) | Paramètre régional utilisé pour localiser les noms d’affichage.                        | `string`                                                              | Oui        | `en`       |
| [`customMapping`](#custom-mapping) | Mappage personnalisé pour les codes de langue et les propriétés du paramètre régional. | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Oui        | —          |

### `locale` [#locale]

**Type** `string` · **Obligatoire**

Le code de langue BCP-47 dont vous souhaitez obtenir les propriétés.

### `defaultLocale` [#default-locale]

**Type** `string` · **Facultatif** · **Par défaut** `en`

Le paramètre régional utilisé pour localiser les noms d’affichage renvoyés.

### `customMapping` [#custom-mapping]

**Type** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Facultatif**

Un mappage personnalisé des codes de langue et des propriétés associées.

## Valeur renvoyée [#returns]

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

Un objet complet contenant toutes les informations sur le paramètre régional :

* `code` : code de langue normalisé.
* `name` : nom d’affichage dans le paramètre régional par défaut.
* `nativeName` : nom d’affichage dans le paramètre régional lui-même.
* `languageCode`, `languageName`, `nativeLanguageName` : informations sur la langue.
* `regionCode`, `regionName`, `nativeRegionName` : informations sur la région.
* `scriptCode`, `scriptName`, `nativeScriptName` : informations sur le système d’écriture.
* `maximizedCode`, `minimizedCode` : formes canoniques.
* `nameWithRegionCode`, `nativeNameWithRegionCode` : formats d’affichage combinés.
* `emoji` : drapeau ou emoji représentatif.

## Exemples [#examples]

```typescript
import { getLocaleProperties } from 'generaltranslation';

// Noms d'affichage en anglais
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Mexican Spanish"
console.log(enProps.languageName); // "Spanish"
console.log(enProps.regionName); // "Mexico"
console.log(enProps.emoji); // "🇲🇽"

// Noms d'affichage en français
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol du Mexique"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"

// Les noms natifs sont toujours dans le paramètre régional cible
console.log(enProps.nativeName); // "español de México"
console.log(frProps.nativeName); // "español de México"
```

## Notes [#notes]

* Fournit des données de paramètre régional sans instancier la classe GT.
* Les propriétés de mappage personnalisé prévalent sur les API `Intl` standard.
* L’objet `LocaleProperties` complet est toujours renvoyé.
* Les noms natifs sont toujours calculés dans le paramètre régional cible lui-même.