# generaltranslation: General Translation Core SDK: getLocaleProperties
URL: https://generaltranslation.com/zh/docs/core/class/methods/locales/get-locale-properties.mdx
---
title: getLocaleProperties
description: GT getLocaleProperties 方法的 API 参考文档
---

## 概述

`getLocaleProperties` 方法用于获取某个区域设置代码的完整属性信息，提供
详细数据，包括显示名称、区域代码、书写系统信息和旗帜 emoji。
它会返回一个完整的 `LocaleProperties` 对象，包含构建丰富的国际化用户界面所需的全部数据。

```typescript
const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

const props = gt.getLocaleProperties('fr-CA');
console.log(props.name); // "French (Canada)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"
```

***


## 参考

### 参数

<TypeTable
  type={{
  "locale?": {
    type: 'string',
    optional: true,
    default: 'this.targetLocale',
  }
}}
/>

### 参数说明

| 参数       | 说明                                               |
| -------- | ------------------------------------------------ |
| `locale` | 要获取其属性的 BCP-47 区域设置代码。若未提供，则使用实例的 `targetLocale` |

### 返回值

`LocaleProperties` - 一个包含所有区域设置信息的完整对象：

* `code`: 标准化的区域设置代码
* `name`: 源区域设置下的显示名称
* `nativeName`: 该区域设置本身的显示名称
* `languageCode`, `languageName`, `nativeLanguageName`: 语言信息
* `regionCode`, `regionName`, `nativeRegionName`: 区域信息
* `scriptCode`, `scriptName`, `nativeScriptName`: 书写系统信息
* `maximizedCode`, `minimizedCode`: 规范化形式
* `nameWithRegionCode`, `nativeNameWithRegionCode`: 组合显示格式
* `emoji`: 旗帜或代表性 emoji

### 抛出

* `Error` - 如果未提供区域设置，且该实例也未配置 `targetLocale`

***

## 示例

### 基本用法

```typescript
const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'fr'
});

// 获取目标区域设置的属性
const props = gt.getLocaleProperties();
console.log(props.name); // "French (France)"
console.log(props.nativeName); // "français (France)"
console.log(props.languageCode); // "fr"
console.log(props.regionCode); // "FR"
console.log(props.emoji); // "🇫🇷"

// 获取其他区域设置的属性
const germanProps = gt.getLocaleProperties('de-AT');
console.log(germanProps.name); // "Austrian German"
console.log(germanProps.nativeName); // "Österreichisches Deutsch"
console.log(germanProps.regionName); // "Austria"
console.log(germanProps.nativeRegionName); // "Österreich"
```

***


## 说明

* 所有显示名称均遵循实例的 `sourceLocale` 设置
* 自定义映射属性优先于标准 Intl API

## 后续步骤

* 了解 [`LocaleProperties`](/docs/core/types/locale-properties) 接口
* 使用 [`getLocaleName`](/docs/core/class/methods/locales/get-locale-name) 获取简短的区域设置名称
* 使用 [`getLocaleEmoji`](/docs/core/class/methods/locales/get-locale-emoji) 获取区域设置对应的 emoji
* 了解 [`CustomMapping`](/docs/core/types/custom-mapping) 类型