Types

CustomMapping

自定义语言代码映射及增强型 locale 元数据的类型定义

概览

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': '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