Utility FunctionsLocales

getLocaleProperties

Référence de l’API de la fonction autonome getLocaleProperties

Vue d’ensemble

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

import { getLocaleProperties } from 'generaltranslation';

const props = getLocaleProperties('fr-CA', 'en');
console.log(props.name); // "French (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 correspondances personnalisées

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

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 langue 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 instancier la classe GT
  • Les propriétés de correspondance personnalisées prévalent 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

Que pensez-vous de ce guide ?

getLocaleProperties