getLocaleProperties
API-Referenz für die eigenständige Funktion getLocaleProperties
Überblick
Die eigenständige Funktion getLocaleProperties ruft Eigenschaften für einen locale code ab, ohne eine Instanz der GT-Klasse zu benötigen.
Sie liefert detaillierte Informationen, darunter Anzeigenamen, Regionscodes, Schriftinformationen und Emoji-Flags, in einem vollständigen LocaleProperties-Objekt.
import { getLocaleProperties } from 'generaltranslation';
const props = getLocaleProperties('fr-CA', 'en');
console.log(props.name); // "Französisch (Kanada)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"
console.log(props.regionCode); // "CA"Referenzen
Parameter
Prop
Type
Parameterbeschreibung
| Parameter | Beschreibung |
|---|---|
locale | BCP‑47‑Locale-Code, für den Eigenschaften abgerufen werden |
defaultLocale | Locale zur Lokalisierung von Anzeigenamen (Standard: „en“) |
customMapping | Optionale CustomMapping für Locale-Codes und Eigenschaften |
Rückgabewert
LocaleProperties - Ein umfassendes Objekt mit allen Locale-Informationen:
code: Standardisierter locale codename: Anzeigename in der Standard-LocalenativeName: Anzeigename in der Locale selbstlanguageCode,languageName,nativeLanguageName: SprachinformationenregionCode,regionName,nativeRegionName: RegionsinformationenscriptCode,scriptName,nativeScriptName: SchriftinformationenmaximizedCode,minimizedCode: Kanonische FormennameWithRegionCode,nativeNameWithRegionCode: Kombinierte Anzeigeformateemoji: Flagge oder repräsentatives Emoji
Verhalten
Integration mit benutzerdefiniertem Mapping
- Benutzerdefinierte Mappings werden bei allen Eigenschaften zuerst geprüft
- Unterstützt Alias-Auflösung und Eigenschaftsüberschreibungen
- Fällt für nicht zugeordnete Codes auf die Standard-Intl-APIs zurück
- Kanonische locale-Auflösung für aliased locales
Beispiele
import { getLocaleProperties } from 'generaltranslation';
// Englische Anzeigenamen
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); // "🇲🇽"
// Französische Anzeigenamen
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol (Mexique)"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"
// Native Namen sind immer in der Zielsprache
console.log(enProps.nativeName); // "español (México)"
console.log(frProps.nativeName); // "español (México)"Hinweise
- Funktion liefert locale-Daten, ohne eine GT-Klasse zu instanziieren
- Benutzerdefinierte Mapping-Eigenschaften haben Vorrang vor den standardmäßigen Intl APIs
- Das vollständige
LocaleProperties-Interface wird immer zurückgegeben - Native Namen werden stets in der Ziel-locale selbst ermittelt
Nächste Schritte
- Erkunden Sie die
LocaleProperties-Schnittstelle – vollständige Dokumentation der Schnittstelle - Verwenden Sie die Methode der GT-Klasse
getLocaleProperties - Abrufen einfacher Locale-Namen mit
getLocaleName - Abrufen von Locale-Emoji mit
getLocaleEmoji
Wie ist diese Anleitung?