Types

CustomMapping

Typdefinition für benutzerdefinierte Zuordnungen von locale codes und erweiterte locale-Metadaten

Überblick

CustomMapping definiert benutzerdefinierte Zuordnungen von locale codes sowie Metadaten, die die standardmäßigen BCP‑47‑Informationen zu locales erweitern oder überschreiben.

type CustomMapping = Record<string, string | Partial<LocaleProperties>>;

Typdefinition

Struktur

CustomMapping ist ein Record mit folgenden Eigenschaften:

  • Keys: Benutzerdefinierte Locale-Codes oder Aliasse (z. B. 'simplified-chinese', 'company-english')
  • Values: Entweder ein einfacher Stringname oder ein partielles LocaleProperties-Objekt

Wertetypen

TypBeschreibungBeispiel
stringEinfacher Anzeigename'Vereinfachtes Chinesisch'
Partial<LocaleProperties>Erweiterte Locale-Metadaten{ code: 'zh-CN', name: 'Chinese', emoji: '🇨🇳' }

Beispiele

Einfache String-Zuordnungen

const simpleMapping: CustomMapping = {
  'english': 'Englisch',
  'spanish': 'Spanisch',
  'mexican-spanish': 'Mexikanisches Spanisch'
};

const gt = new GT({
  sourceLocale: 'english',
  targetLocale: 'spanish',
  customMapping: simpleMapping
});

Erweiterte Locale-Metadaten

const enhancedMapping: CustomMapping = {
  'simplified-chinese': {
    code: 'zh-CN',
    name: 'Vereinfachtes Chinesisch',
    nativeName: '简体中文',
    regionName: 'China',
    emoji: '🇨🇳'
  }
};

Hinweise

  • Benutzerdefinierte Zuordnungen setzen die standardmäßige BCP-47-Locale-Auflösung außer Kraft
  • Zeichenfolgenwerte liefern einfache Anzeigenamen
  • Teilweise LocaleProperties ermöglichen eine detaillierte Locale-Anpassung
  • Benutzerdefinierte Zuordnungen werden während der Initialisierung der GT-Instanz aufgelöst

Verwandte Typen

Wie ist dieser Leitfaden?

CustomMapping