# generaltranslation: General Translation Core SDK: CustomMapping
URL: https://generaltranslation.com/zh/docs/core/types/custom-mapping.mdx
---
title: CustomMapping
description: 自定义区域设置代码映射及增强的区域设置元数据的类型定义
---

## 概述

`CustomMapping` 用于定义自定义的区域设置代码映射及元数据，以扩展或覆盖标准 BCP-47 区域设置信息。

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


## 类型定义

### 结构

`CustomMapping` 是一种记录类型，其中：

* **键**：自定义区域设置代码或别名 (例如 `'simplified-chinese'`、`'company-english'`) 
* **值**：简单的字符串名称，或部分 `LocaleProperties` 对象

### 值类型

| 类型                          | 说明         | 示例                                                  |
| --------------------------- | ---------- | --------------------------------------------------- |
| `string`                    | 简单的显示名称    | `'Simplified Chinese'`                              |
| `Partial<LocaleProperties>` | 增强的区域设置元数据 | `{ code: 'zh-CN', name: 'Chinese', emoji: '🇨🇳' }` |

***

## 示例

### 简单的字符串映射

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

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


### 增强的区域设置元数据

```typescript copy
const enhancedMapping: CustomMapping = {
  'simplified-chinese': {
    code: 'zh-CN',
    name: 'Simplified Chinese',
    nativeName: '简体中文',
    regionName: 'China',
    emoji: '🇨🇳'
  }
};
```

***


## 注意事项

* 自定义映射会覆盖标准的 BCP-47 区域设置确定逻辑
* 字符串值可提供简单的显示名称
* 部分 LocaleProperties 可实现更细粒度的区域设置自定义
* 自定义映射会在 GT 实例初始化时确定

## 相关类型

* [`LocaleProperties`](/docs/core/types/locale-properties) - 完整的区域设置元数据结构