# generaltranslation: General Translation Core SDK: getRegionProperties
URL: https://generaltranslation.com/zh/docs/core/functions/locales/get-region-properties.mdx
---
title: getRegionProperties
description: getRegionProperties 函数的 API 参考文档
---

## 概述

`getRegionProperties` 函数可在无需 GT 类实例的情况下获取地区代码的详细信息。

***

## 参考

### 参数

<TypeTable
  type={{
  "region": {
    type: 'string',
    optional: false,
  },
  "defaultLocale?": {
    type: 'string',
    optional: true,
  },
  "customMapping?": {
    type: 'CustomRegionMapping',
    optional: true,
  }
}}
/>

### 返回值

`{ code: string; name: string; emoji: string }` - 地区信息对象

***

## 示例

```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: '🇺🇸' }
```

***


## 说明

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

## 后续步骤

* 使用 GT 类中的 [`getRegionProperties`](/docs/core/class/methods/locales/get-region-properties) 方法
* 使用 [`getLocaleProperties`](/docs/core/functions/locales/get-locale-properties) 获取完整的区域设置信息