# General Translation Platform: resolveCanonicalLocale
URL: https://generaltranslation.com/fr/docs/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale.mdx
---
title: resolveCanonicalLocale
description: Résoudre un alias de paramètre régional en son code de langue canonique sur une instance GT. Référence d’API pour resolveCanonicalLocale.

---

Résout un alias de paramètre régional en code de langue BCP-47 canonique utilisé en interne sur une instance [GT](/docs/platform/core/reference/gt-class/constructor). Il s’agit de l’inverse de [`resolveAliasLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-alias-locale). General Translation utilise un mapping personnalisé pour vous permettre d’exposer vos propres codes de langue tout en traduisant et en appliquant le formatage à partir de codes standard en interne.

## Vue d’ensemble [#overview]

Appelez `resolveCanonicalLocale` sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor) en lui passant un code de langue. Elle renvoie le paramètre régional canonique si le code est un alias configuré ; sinon, elle renvoie le paramètre régional d’entrée tel quel.

```typescript
const gt = new GT({
  sourceLocale: 'en',
  customMapping: {
    cn: { code: 'zh', name: 'Mandarin' },
  },
});

const canonical = gt.resolveCanonicalLocale('cn');
console.log(canonical); // "zh"
```

Signature :

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

*Remarque : `resolveCanonicalLocale` s’exécute localement et ne nécessite pas de clé API. Il utilise le paramètre régional cible de l’instance et `customMapping` lorsque les arguments sont omis. Pour effectuer cette résolution sans instance `GT`, consultez la version autonome de [`resolveCanonicalLocale`](/docs/platform/core/reference/utility-functions/locales/resolve-canonical-locale).*

## Fonctionnement [#how-it-works]

* **Recherche directe.** Recherche le paramètre régional canonique correspondant à un alias dans [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping).
* **Transmission inchangée.** Renvoie le paramètre régional d'entrée tel quel lorsqu'il n'a pas de mapping canonique.
* **Repli sur l'instance.** Lorsque `locale` est omis, le paramètre régional cible de l'instance est utilisé ; lorsque `customMapping` est omis, le `customMapping` de l'instance est utilisé.
* **Lève une erreur** lorsqu'aucun paramètre régional n'est disponible (ni argument ni paramètre régional cible de l'instance).

## Paramètres [#parameters]

| Paramètre                          | Description                                                        | Type                                                                  | Facultatif | Par défaut           |
| ---------------------------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------- | ---------- | -------------------- |
| [`locale`](#locale)                | Le code de langue alias à faire correspondre à sa forme canonique. | `string`                                                              | Oui        | `this.targetLocale`  |
| [`customMapping`](#custom-mapping) | Mapping personnalisé à utiliser à la place de celui de l’instance. | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Oui        | `this.customMapping` |

### `locale` [#locale]

**Type** `string` · **Facultatif** · **Par défaut** `this.targetLocale`

Le code de langue alias à résoudre. Utilise par défaut le paramètre régional cible de l’instance s’il n’est pas spécifié.

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

**Type** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Facultatif** · **Par défaut** `this.customMapping`

Mapping personnalisé à utiliser à la place de celui de l’instance.

## Valeur de retour [#returns]

**Type** `string`

Le paramètre régional canonique de l’alias, ou le paramètre régional d’entrée inchangé si aucun mapping canonique n’existe.

## Exemples [#examples]

```typescript
const gt = new GT({
  sourceLocale: 'en',
  customMapping: {
    cn: { code: 'zh', name: 'Mandarin' },
  },
});

// Résoudre l'alias en paramètre régional canonique
console.log(gt.resolveCanonicalLocale('cn')); // "zh"

// Un paramètre régional sans correspondance retourne l'original
console.log(gt.resolveCanonicalLocale('es')); // "es"
```

## Notes [#notes]

* Il s’agit de l’inverse de [`resolveAliasLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-alias-locale).
* Renvoie le paramètre régional d’entrée tel quel si aucun mapping canonique n’est trouvé.