GT ClassMethodsLocales

resolveCanonicalLocale

Référence de l’API pour la méthode resolveCanonicalLocale de GT

Aperçu

Utilisée dans le contexte de l’aliasing des locales (p. ex. cn -> zh), la méthode resolveCanonicalLocale convertit les codes de locale alias en leurs codes de locale BCP‑47 canoniques lorsqu’un mappage personnalisé est configuré.


Références

Paramètres

Prop

Type

Description des paramètres

ParamètreDescription
localeCode de locale alias à convertir en forme canonique. S’il n’est pas renseigné, utilise le targetLocale de l’instance
customMappingMappage personnalisé facultatif à utiliser à la place du mappage de l’instance

Renvoie

string - Le code de locale BCP‑47 canonique si un mapping existe, sinon le code de locale d’origine

Exceptions levées

  • Error - Si aucune locale n’est fournie et que l’instance n’a aucun targetLocale configuré

Exemples

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

// Convertir l'alias vers le locale canonique
const canonical = gt.resolveCanonicalLocale('cn');
console.log(canonical); // "zh"

// Les codes BCP-47 standards passent inchangés
const unchanged = gt.resolveCanonicalLocale('fr-FR');
console.log(unchanged); // "fr-FR"

Notes

  • Convertit les codes de locale alias en codes de locale BCP-47 canoniques
  • Renvoie la locale d’origine s’il n’existe aucun mappage personnalisé
  • Fonctionne avec la configuration customMapping du constructeur GT
  • Aucune validation n’est effectuée sur les codes de locale en entrée ou en sortie

Prochaines étapes

Que pensez-vous de ce guide ?

resolveCanonicalLocale