Types
CustomMapping
カスタムロケールコードのマッピングと拡張ロケールメタデータの型定義
概要
CustomMapping は、標準的な BCP-47 の locale 情報を拡張または上書きするための、カスタムのロケールコードのマッピングとメタデータを定義します。
type CustomMapping = Record<string, string | Partial<LocaleProperties>>;型の定義
構造
CustomMapping は次のようなレコードです:
- キー: カスタムのロケールコードまたはエイリアス（例:
'simplified-chinese'、'company-english'） - 値: 単純な文字列の名称、または
LocalePropertiesの部分オブジェクト
値の型
| 型 | 説明 | 例 |
|---|---|---|
string | シンプルな表示名 | 'Simplified Chinese' |
Partial<LocaleProperties> | 拡張された locale メタデータ | { code: 'zh-CN', name: 'Chinese', emoji: '🇨🇳' } |
例
シンプルな文字列のマッピング
const simpleMapping: CustomMapping = {
'english': '英語',
'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 解決より優先されます
- 文字列の value で簡易な表示名を指定できます
- 部分的な LocaleProperties により、locale を詳細にカスタマイズできます
- カスタムマッピングは GT インスタンスの初期化時に解決されます
関連する型
LocaleProperties- locale のメタデータを網羅した構造体
このガイドはいかがですか?