Utility FunctionsLocales

getLocaleProperties

Référence de l’API pour la fonction indépendante getLocaleProperties

Aperçu

La fonction autonome getLocaleProperties récupère les propriétés d’un code de locale sans nécessiter d’instance de GT. Elle fournit des informations détaillées — noms d’affichage, codes de région, informations d’écriture et drapeaux emoji — dans un objet LocaleProperties complet.

import { getLocaleProperties } from 'generaltranslation';

const props = getLocaleProperties('fr-CA', 'en');
console.log(props.name); // "Français (Canada)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"
console.log(props.regionCode); // "CA"

Références

Paramètres

Prop

Type

Description des paramètres

ParamètreDescription
localecode de locale BCP-47 pour lequel récupérer les propriétés
defaultLocaleLocale à utiliser pour localiser les noms d’affichage (par défaut « en »)
customMappingMappage personnalisé optionnel pour les codes de locale et leurs propriétés

Renvoie

LocaleProperties - Un objet complet contenant toutes les informations de locale :

  • code: Code de locale standardisé
  • name: Nom d’affichage dans la locale par défaut
  • nativeName: Nom d’affichage dans la locale elle‑même
  • languageCode, languageName, nativeLanguageName: Informations sur la langue
  • regionCode, regionName, nativeRegionName: Informations sur la région
  • scriptCode, scriptName, nativeScriptName: Informations sur l’écriture
  • maximizedCode, minimizedCode: Formes canoniques
  • nameWithRegionCode, nativeNameWithRegionCode: Formats d’affichage combinés
  • emoji: Drapeau ou emoji représentatif

Comportement

Intégration de mappage personnalisé

  • Les mappages personnalisés sont vérifiés en premier pour toutes les propriétés
  • Prend en charge la résolution des alias et le remplacement des propriétés
  • Bascule vers les API Intl standard pour les codes non mappés
  • Résolution canonique des locales pour les locales avec alias

Exemples

import { getLocaleProperties } from 'generaltranslation';

// Noms d'affichage en anglais
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Spanish (Mexico)"
console.log(enProps.languageName); // "Spanish"
console.log(enProps.regionName); // "Mexico"
console.log(enProps.emoji); // "🇲🇽"

// Noms d'affichage en français
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol (Mexique)"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"

// Les noms natifs sont toujours dans la locale cible
console.log(enProps.nativeName); // "español (México)"
console.log(frProps.nativeName); // "español (México)"

Notes

  • La fonction fournit des données de locale sans instanciation de la GT class
  • Les propriétés de mappage personnalisées priment sur les API Intl standard
  • L’interface complète LocaleProperties est toujours renvoyée
  • Les noms natifs sont toujours calculés dans la locale cible elle‑même

Prochaines étapes

Comment trouvez-vous ce guide ?