# General Translation Platform: getRegionProperties
URL: https://generaltranslation.com/fr/docs/platform/core/reference/utility-functions/locales/get-region-properties.mdx
---

title: getRegionProperties
description: Renvoie les métadonnées d’une région sans instance GT. Référence de l’API pour getRegionProperties.

---

[`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) est une fonction utilitaire autonome de la bibliothèque Core de General Translation qui renvoie des métadonnées sur un code de région, notamment son nom localisé et un émoji représentatif.

## Vue d’ensemble [#overview]

Importez `getRegionProperties` directement depuis `generaltranslation` et appelez-la avec un code de région et, éventuellement, un paramètre régional d’affichage. Elle 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 [`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor).

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

console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }
```

Signature :

```typescript
getRegionProperties(
  region: string,
  defaultLocale?: string,
  customMapping?: CustomRegionMapping
): { code: string; name: string; emoji: string }
```

## Fonctionnement [#how-it-works]

* **Noms localisés.** Utilise l’API `Intl.DisplayNames` pour générer des noms de région localisés selon `defaultLocale`.
* **Codes de région.** Prend en charge les codes de région ISO 3166-1 alpha-2 et ONU M.49.
* **Mapping personnalisé.** Un `CustomRegionMapping` peut remplacer les noms et les émojis par défaut.
* **Contenu de secours.** Utilise le code de région comme contenu de secours si la résolution du nom d’affichage échoue.

## Paramètres [#parameters]

| Paramètre                          | Description                                                            | Type                  | Facultatif | Par défaut |
| ---------------------------------- | ---------------------------------------------------------------------- | --------------------- | ---------- | ---------- |
| [`region`](#region)                | Code de région dont les propriétés doivent être récupérées.            | `string`              | Non        | —          |
| [`defaultLocale`](#default-locale) | Paramètre régional utilisé pour localiser le nom de la région.         | `string`              | Oui        | `en`       |
| [`customMapping`](#custom-mapping) | Mapping personnalisé pour les codes de région, les noms et les émojis. | `CustomRegionMapping` | Oui        | —          |

### `region` [#region]

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

Le code de la région dont récupérer les propriétés (ISO 3166-1 alpha-2 ou UN M.49).

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

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

Le paramètre régional utilisé pour localiser le nom de la région renvoyée.

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

**Type** `CustomRegionMapping` · **Facultatif**

mapping personnalisé facultatif des codes de région, pouvant remplacer les noms et les émojis par défaut.

## Valeur de retour [#returns]

**Type** `{ code: string; name: string; emoji: string }`

Un objet contenant les informations sur la région : son code, son nom localisé et son emoji.

## Exemples [#examples]

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

// Propriétés de région avec des noms en anglais
console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

console.log(getRegionProperties('JP', 'en-US'));
// { code: 'JP', name: 'Japan', emoji: '🇯🇵' }

// Propriétés de région avec des noms localisés
console.log(getRegionProperties('US', 'de-DE'));
// { code: 'US', name: 'Vereinigte Staaten', emoji: '🇺🇸' }
```

## Remarques [#notes]

* Utilise l’API `Intl.DisplayNames` pour les noms de régions localisés.
* Prend en charge les codes de région ISO 3166-1 alpha-2 et UN M.49.
* Des mappings personnalisés peuvent remplacer les noms et emojis par défaut.
* Utilise le code de région comme solution de repli si la résolution du nom d’affichage échoue.
* Aucune dépendance externe en dehors des API du navigateur.