Types

CustomMapping

カスタムのロケールコードマッピングおよび拡張ロケールメタデータの型定義

概要

CustomMapping は、標準の BCP-47 のロケール情報を拡張または上書きするための、カスタムなロケールコードのマッピングとメタデータを定義します。

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

型定義

構造

CustomMapping は次のようなレコードです:

  • キー: カスタムのロケールコードまたはエイリアス(例: 'simplified-chinese''company-english'
  • : 単純な文字列の名称、または部分的な LocaleProperties オブジェクト

値の型

説明
stringシンプルな表示名'簡体字中国語'
Partial<LocaleProperties>拡張された locale メタデータ{ code: 'zh-CN', name: 'Chinese', emoji: '🇨🇳' }

シンプルな文字列のマッピング

const simpleMapping: CustomMapping = {
  'english': 'English',
  'spanish': 'Spanish',
  'mexican-spanish': 'Mexican Spanish'
};

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

強化されたlocaleメタデータ

const enhancedMapping: CustomMapping = {
  'simplified-chinese': {
    code: 'zh-CN',
    name: '簡体字中国語',
    nativeName: '简体中文',
    regionName: '中国',
    emoji: '🇨🇳'
  }
};

注意事項

  • カスタムマッピングは、標準的な BCP-47 の locale 解決より優先されます
  • 文字列の値は簡易な表示名を提供します
  • 一部のみの LocaleProperties を指定して、locale の詳細なカスタマイズが可能です
  • カスタムマッピングは GT インスタンスの初期化時に解決されます

関連する型

このガイドはどうでしたか?

CustomMapping