# gt-node: General Translation Node.js SDK: getLocaleProperties
URL: https://generaltranslation.com/fr/docs/node/reference/functions/get-locale-properties.mdx
---

title: getLocaleProperties
description: Consultez les métadonnées d’affichage d’un paramètre régional dans General Translation gt-node. Référence de l’API pour getLocaleProperties.

---

Retourne les métadonnées d’un paramètre régional : son nom, son nom dans sa langue d’origine, sa langue, sa région et les informations sur le système d’écriture. Utilisez-les pour créer des sélecteurs de paramètres régionaux ou afficher ces métadonnées aux utilisateurs.

## Vue d’ensemble [#overview]

Appelez `getLocaleProperties` avec un code de langue, ou sans argument pour utiliser le paramètre régional en cours. Cette fonction renvoie un objet [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties).

```ts
import { getLocaleProperties } from 'gt-node';

const props = getLocaleProperties('en-US');
console.log(props.name); // 'American English'
```

Signature :

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

*Remarque : cette fonction est synchrone — il n’est pas nécessaire d’utiliser await.*

## Fonctionnement [#how-it-works]

* **Paramètre régional de repli.** Lorsque `locale` n’est pas indiqué, il correspond au paramètre régional actuel.
* **Sous-balises dérivées.** Il résout les sous-balises de langue, d’écriture et de région, ainsi que leurs noms d’affichage et les formes maximisées.
* **Synchrone.** Le résultat est renvoyé immédiatement et ne nécessite aucune requête réseau.

## Paramètres [#parameters]

| Paramètre           | Description                      | Type     | Facultatif | Par défaut                |
| ------------------- | -------------------------------- | -------- | ---------- | ------------------------- |
| [`locale`](#locale) | Code de langue BCP 47 à décrire. | `string` | Oui        | Paramètre régional actuel |

### `locale` [#locale]

**Type** `string` · **Facultatif** · **Par défaut** paramètre régional actuel

Un code de langue BCP 47 (par exemple, `'en-US'`, `'ja'`). S’il n’est pas fourni, le paramètre régional actuel est utilisé.

## Valeur de retour [#returns]

**Type** `LocaleProperties`

Un objet `LocaleProperties` avec les champs suivants :

| Champ                      | Type     | Description                                                                                |
| -------------------------- | -------- | ------------------------------------------------------------------------------------------ |
| `code`                     | `string` | Le code de langue (par exemple, `'en-US'`).                                                |
| `name`                     | `string` | Le nom anglais du paramètre régional (par exemple, `'American English'`).                  |
| `nativeName`               | `string` | Le nom du paramètre régional dans sa propre langue (par exemple, `'American English'`).    |
| `languageCode`             | `string` | La sous-balise de langue (par exemple, `'en'`).                                            |
| `languageName`             | `string` | Le nom anglais de la langue (par exemple, `'English'`).                                    |
| `nativeLanguageName`       | `string` | Le nom de la langue dans sa propre langue (par exemple, `'English'`).                      |
| `nameWithRegionCode`       | `string` | Le nom du paramètre régional avec la région (par exemple, `'English (US)'`).               |
| `nativeNameWithRegionCode` | `string` | Le nom natif du paramètre régional avec la région.                                         |
| `regionCode`               | `string` | La sous-balise de région (par exemple, `'US'`).                                            |
| `regionName`               | `string` | Le nom anglais de la région (par exemple, `'United States'`).                              |
| `nativeRegionName`         | `string` | Le nom de la région dans la langue du paramètre régional.                                  |
| `scriptCode`               | `string` | La sous-balise d’écriture (par exemple, `'Latn'`).                                         |
| `scriptName`               | `string` | Le nom anglais de l’écriture (par exemple, `'Latin'`).                                     |
| `nativeScriptName`         | `string` | Le nom de l’écriture dans la langue du paramètre régional.                                 |
| `maximizedCode`            | `string` | Le code de langue entièrement développé (par exemple, `'en-Latn-US'`).                     |
| `maximizedName`            | `string` | Le nom anglais du paramètre régional maximisé (par exemple, `'American English (Latin)'`). |
| `nativeMaximizedName`      | `string` | Le nom du paramètre régional maximisé dans sa propre langue.                               |
| `minimizedCode`            | `string` | Le code de langue minimal (par exemple, `'en'`).                                           |
| `minimizedName`            | `string` | Le nom anglais du paramètre régional minimisé.                                             |
| `nativeMinimizedName`      | `string` | Le nom du paramètre régional minimisé dans sa propre langue.                               |
| `emoji`                    | `string` | Un drapeau ou un emoji représentatif du paramètre régional.                                |

## Exemples [#examples]

```ts title="handler.js"
// Utilisation de base
import { getLocaleProperties } from 'gt-node';

app.get('/api/locale-info', (req, res) => {
  const props = getLocaleProperties('ja');
  res.json({
    name: props.name,             // 'Japanese'
    nativeName: props.nativeName, // '日本語'
    script: props.scriptName,     // 'Japanese'
  });
});
```

## Notes [#notes]

* Cette fonction est synchrone — il n’est pas nécessaire de l’attendre.
* Utile pour créer des sélecteurs de paramètres régionaux ou afficher aux utilisateurs des métadonnées de paramètres régionaux.