# generaltranslation: General Translation Core SDK: getLocaleProperties
URL: https://generaltranslation.com/fr/docs/core/functions/locales/get-locale-properties.mdx
---
title: getLocaleProperties
description: Référence API de la fonction getLocaleProperties autonome
---

## Vue d’ensemble

La fonction autonome `getLocaleProperties` récupère les propriétés d’un code de langue sans nécessiter d’instance de la classe GT.
Elle renvoie des informations détaillées, notamment les noms d’affichage, les codes de région, le système d’écriture et les drapeaux emoji, dans un objet `LocaleProperties` complet.

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

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

***


## Référence

### Paramètres

<TypeTable
  type={{
  "locale": {
    type: 'string',
    optional: false,
  },
  "defaultLocale?": {
    type: 'string',
    optional: true,
  },
  "customMapping?": {
    type: 'CustomMapping',
    optional: true,
  }
}}
/>

### Description des paramètres

| Paramètre       | Description                                                                                   |
| --------------- | --------------------------------------------------------------------------------------------- |
| `locale`        | Code de langue BCP-47 dont récupérer les propriétés                                           |
| `defaultLocale` | Paramètre régional à utiliser pour localiser les noms d’affichage (par défaut : &#39;en&#39;) |
| `customMapping` | Mappage personnalisé facultatif pour les codes de langue et les propriétés                    |

### Retourne

`LocaleProperties` - 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 ce paramètre régional
* `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

***

## Comportement

### Intégration avec mappage personnalisé

* Les mappages personnalisés sont consultés en priorité pour toutes les propriétés
* Prend en charge la résolution des alias et la redéfinition des propriétés
* Utilise les API Intl standard pour les codes non mappés
* Résolution du paramètre régional standard pour les paramètres régionaux aliasés

***

## Exemples

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

// Noms d'affichage en anglais
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Spanish (Mexico)"
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 (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 (México)"
console.log(frProps.nativeName); // "español (México)"
```

***


## Remarques

* La fonction fournit des données de paramètre régional sans instancier la classe GT
* Les propriétés de mappage personnalisées priment sur les API Intl standard
* L’interface `LocaleProperties` complète est toujours renvoyée
* Les noms natifs sont toujours déterminés directement dans le paramètre régional cible

## Étapes suivantes

* Consultez l&#39;[interface `LocaleProperties`](/docs/core/types/locale-properties) - Documentation complète de l&#39;interface
* Utilisez la méthode [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties) de la classe GT
* Obtenez des noms de paramètres régionaux simples avec [`getLocaleName`](/docs/core/functions/locales/get-locale-name)
* Obtenez l&#39;emoji du paramètre régional avec [`getLocaleEmoji`](/docs/core/functions/locales/get-locale-emoji)