# General Translation Platform: getRegionProperties
URL: https://generaltranslation.com/zh/docs/platform/core/reference/utility-functions/locales/get-region-properties.mdx
---

title: getRegionProperties
description: 无需 GT 实例即可返回地区元数据。getRegionProperties 的 API 参考。

---

[`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) 是 General Translation 核心库提供的独立工具函数，用于返回区域代码的元数据，包括其本地化名称和对应的 表情符号。

## 概览 [#overview]

直接从 `generaltranslation` 导入 `getRegionProperties`，并传入区域代码以及可选的显示区域设置来调用。它不需要 API Key，也不需要 [`GT`](/docs/platform/core/reference/gt-class/constructor) 实例。若要使用基于实例的等效方法，请改用 [`GT`](/docs/platform/core/reference/gt-class/constructor) 实例上的 [`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) 方法。

```typescript
import { getRegionProperties } from 'generaltranslation';

console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }
```

签名：

```typescript
getRegionProperties(
  region: string,
  defaultLocale?: string,
  customMapping?: CustomRegionMapping
): { code: string; name: string; emoji: string }
```

## 工作原理 [#how-it-works]

* **本地化名称。** 使用 `Intl.DisplayNames` API 生成按 `defaultLocale` 本地化的区域名称。
* **区域代码。** 支持 ISO 3166-1 alpha-2 和 UN M.49 区域代码。
* **自定义映射。** `CustomRegionMapping` 可覆盖默认名称和表情符号。
* **回退机制。** 如果无法解析显示名称，则回退为区域代码。

## 参数 [#parameters]

| 参数                                 | 描述                    | 类型                    | 可选 | 默认   |
| ---------------------------------- | --------------------- | --------------------- | -- | ---- |
| [`region`](#region)                | 要获取属性的地区代码。           | `string`              | 否  | —    |
| [`defaultLocale`](#default-locale) | 用于本地化区域名称的区域设置。       | `string`              | 是  | `en` |
| [`customMapping`](#custom-mapping) | 用于地区代码、名称和表情符号的自定义映射。 | `CustomRegionMapping` | 是  | —    |

### `region` [#region]

**类型** `string` · **必填**

要获取其属性的区域代码 (ISO 3166-1 alpha-2 或 UN M.49) 。

### `defaultLocale` [#default-locale]

**类型** `string` · **可选** · **默认值** `en`

用于本地化返回的区域名称的区域设置。

### `customMapping` [#custom-mapping]

**类型** `CustomRegionMapping` · **可选**

可选的区域代码自定义映射，可覆盖默认名称和表情符号。

## 返回值 [#returns]

**类型** `{ code: string; name: string; emoji: string }`

一个区域信息对象，包含区域代码、本地化名称和表情符号。

## 示例 [#examples]

```typescript
import { getRegionProperties } from 'generaltranslation';

// 使用英文名称的地区属性
console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

console.log(getRegionProperties('JP', 'en-US'));
// { code: 'JP', name: 'Japan', emoji: '🇯🇵' }

// 使用本地化名称的地区属性
console.log(getRegionProperties('US', 'de-DE'));
// { code: 'US', name: 'Vereinigte Staaten', emoji: '🇺🇸' }
```

## 说明 [#notes]

* 使用 `Intl.DisplayNames` API 获取本地化的区域名称。
* 支持 ISO 3166-1 alpha-2 和 UN M.49 区域代码。
* 自定义映射可覆盖默认名称和表情符号。
* 如果显示名称解析失败，则回退到区域代码。
* 除浏览器 API 外，无需任何外部依赖。