# General Translation Platform: resolveCanonicalLocale
URL: https://generaltranslation.com/fr/docs/platform/core/reference/utility-functions/locales/resolve-canonical-locale.mdx
---

title: resolveCanonicalLocale
description: Résout un alias de paramètre régional en code de langue BCP-47 canonique sans instance GT. Référence d’API pour resolveCanonicalLocale.

---

[`resolveCanonicalLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale) est une fonction utilitaire autonome de la bibliothèque Core de General Translation qui résout un alias de paramètre régional en code de langue BCP-47 canonique utilisé en interne. C’est l’inverse de [`resolveAliasLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-alias-locale).

## Vue d’ensemble [#overview]

Importez `resolveCanonicalLocale` directement depuis `generaltranslation` et appelez-la avec un code de langue et, éventuellement, un mapping personnalisé. Elle ne nécessite ni clé API ni instance de [GT](/docs/platform/core/reference/gt-class/constructor). Pour une résolution basée sur une instance qui hérite du mapping de celle-ci, utilisez plutôt la méthode [`resolveCanonicalLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale) sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor).

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

const canonical = resolveCanonicalLocale('en', { en: { code: 'en-US' } });
// "en-US"
```

Signature :

```typescript
resolveCanonicalLocale(
  locale: string,
  customMapping?: CustomMapping
): string
```

## Fonctionnement [#how-it-works]

* **Recherche directe.** Recherche le paramètre régional canonique associé à un alias dans [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping).
* **Transmission directe.** Renvoie le paramètre régional d’entrée tel quel lorsqu’il n’a pas de correspondance canonique.

## Paramètres [#parameters]

| Paramètre                          | Description                                                                      | Type                                                                  | Facultatif | Par défaut |
| ---------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------- | ---------- |
| [`locale`](#locale)                | Le code de langue alias à convertir vers sa forme canonique.                     | `string`                                                              | Non        | —          |
| [`customMapping`](#custom-mapping) | Le mapping personnalisé utilisé pour déterminer le paramètre régional canonique. | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Oui        | —          |

### `locale` [#locale]

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

Le code de langue alias à résoudre.

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

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

Mapping personnalisé utilisé pour déterminer le paramètre régional canonique.

## Renvoie [#returns]

**Type** `string`

Le paramètre régional canonique correspondant à l’alias, ou le paramètre régional d’entrée inchangé s’il n’existe aucune correspondance canonique.

## Exemples [#examples]

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

// Aucun mapping — retourne l'entrée inchangée
console.log(resolveCanonicalLocale('en-US')); // "en-US"

// Avec un mapping personnalisé — résout l'alias
console.log(resolveCanonicalLocale('en', { en: { code: 'en-US' } })); // "en-US"
```

## Notes [#notes]

* Il s’agit de l’opposé de [`resolveAliasLocale`](/docs/platform/core/reference/utility-functions/locales/resolve-alias-locale).
* Renvoie le paramètre régional fourni tel quel si aucune correspondance canonique n’est trouvée.