# General Translation Platform: getRegionProperties
URL: https://generaltranslation.com/ru/docs/platform/core/reference/utility-functions/locales/get-region-properties.mdx
---
title: getRegionProperties
description: Возвращает метаданные региона без экземпляра GT. Справочник API для getRegionProperties.

---

[`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) — это автономная служебная функция из библиотеки Core от General Translation, которая возвращает метаданные кода региона, включая его локализованное название и соответствующий эмодзи.

## Обзор [#overview]

Импортируйте `getRegionProperties` напрямую из `generaltranslation` и вызовите её, передав код региона и необязательную локаль для отображения. Для этого не требуется API-ключ или экземпляр [GT](/docs/platform/core/reference/gt-class/constructor). Если вам нужен вариант с использованием экземпляра, используйте метод [`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) экземпляра [`GT`](/docs/platform/core/reference/gt-class/constructor).

```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]

* **Локализованные названия.** Использует API `Intl.DisplayNames` для получения названий регионов, локализованных для `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]

* Использует API `Intl.DisplayNames` для локализованных названий регионов.
* Поддерживает коды регионов ISO 3166-1 alpha-2 и UN M.49.
* Пользовательские сопоставления могут переопределять стандартные названия и эмодзи.
* Если не удаётся определить отображаемое имя, используется код региона.
* Не имеет внешних зависимостей, кроме API браузера.