Utility FunctionsLocales

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 dass eine Instanz der GT-Klasse erforderlich ist. Sie liefert detaillierte Informationen, darunter Anzeigenamen, Regionscodes, Skriptinformationen und Flaggen-Emojis, 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"

Referenz

Parameter

Prop

Type

Parameterbeschreibung

ParameterBeschreibung
localeBCP-47-Locale-Code, für den Eigenschaften abgerufen werden
defaultLocaleLocale zur Lokalisierung von Anzeigenamen (Standard: 'en')
customMappingOptionale benutzerdefinierte Zuordnung für Locale-Codes und Eigenschaften

Rückgabe

LocaleProperties - Ein umfassendes Objekt mit allen Informationen zur Locale:

  • code: Standardisierter Locale-Code
  • name: Anzeigename in der Standard-Locale
  • nativeName: Anzeigename in der jeweiligen Locale
  • languageCode, languageName, nativeLanguageName: Sprachinformationen
  • regionCode, regionName, nativeRegionName: Regionsinformationen
  • scriptCode, scriptName, nativeScriptName: Schriftsysteminformationen
  • maximizedCode, minimizedCode: Kanonische Formen
  • nameWithRegionCode, nativeNameWithRegionCode: Kombinierte Anzeigeformate
  • emoji: Flagge oder repräsentatives Emoji

Verhalten

Integration benutzerdefinierter Zuordnungen

  • Benutzerdefinierte Zuordnungen werden für alle Eigenschaften zuerst geprüft
  • Unterstützt Aliasauflösung und Überschreiben von Eigenschaften
  • Fällt für nicht zugeordnete Codes auf die standardmäßigen 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); // "Spanisch (Mexiko)"
console.log(enProps.languageName); // "Spanisch"
console.log(enProps.regionName); // "Mexiko"
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

  • Liefert Locale-Daten ohne Instanziierung der GT-Klasse
  • Benutzerdefinierte Mapping-Eigenschaften haben Vorrang vor den standardmäßigen Intl APIs
  • Die vollständige LocaleProperties-Schnittstelle wird immer zurückgegeben
  • Native Namen werden stets in der jeweiligen Ziel-Locale ermittelt

Nächste Schritte

Wie ist dieser Leitfaden?

getLocaleProperties