博客Dashboard
Types

CustomMapping

自定义语言代码映射与扩展语言元数据的类型定义

概览

CustomMapping 用于定义自定义的语言代码映射及其元数据，以扩展或覆盖标准 BCP-47 的 locale 信息。

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

类型定义

结构

CustomMapping 是一个记录（record），其中：

  • 键：自定义语言代码或别名（例如 '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 实例时进行解析

相关类型

本指南如何?

本页目录

概览
类型定义
结构
值类型
示例
简单字符串映射
增强的 locale 元数据
说明
相关类型