# gt-node: General Translation Node.js SDK: getLocaleProperties
URL: https://generaltranslation.com/ru/docs/node/reference/functions/get-locale-properties.mdx
---

title: getLocaleProperties
description: Отображаемые метаданные локали в General Translation gt-node. Справочник API по getLocaleProperties.

---

Возвращает метаданные о локали: её название, самоназвание, язык, регион и информацию о письменности. Используйте это, чтобы создавать селекторы локали или показывать пользователям метаданные локали.

## Обзор [#overview]

Вызовите `getLocaleProperties`, передав код локали, или без аргументов, чтобы использовать текущую локаль. Возвращает объект [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties).

```ts
import { getLocaleProperties } from 'gt-node';

const props = getLocaleProperties('en-US');
console.log(props.name); // 'American English'
```

Сигнатура:

```ts
getLocaleProperties(locale?: string): LocaleProperties
```

*Примечание: Эта функция синхронная — await для неё не нужен.*

## Как это работает [#how-it-works]

* **Резервная локаль.** Если `locale` не указана, используется текущая локаль.
* **Производные подтеги.** Определяет подтеги языка, письменности и региона, их отображаемые имена, а также максимизированные формы.
* **Синхронно.** Возвращает результат сразу и не требует сетевого запроса.

## Параметры [#parameters]

| Параметр            | Описание                                      | Тип      | Необязательно | По умолчанию   |
| ------------------- | --------------------------------------------- | -------- | ------------- | -------------- |
| [`locale`](#locale) | Код локали BCP 47, который требуется описать. | `string` | Да            | Текущая локаль |

### `locale` [#locale]

**Тип** `string` · **Необязательно** · **По умолчанию** Текущая локаль

Код локали BCP 47 (например, `'en-US'`, `'ja'`). Если не указано, используется текущая локаль.

## Возвращает [#returns]

**Тип** `LocaleProperties`

Объект `LocaleProperties` со следующими полями:

| Поле                       | Тип      | Описание                                                                         |
| -------------------------- | -------- | -------------------------------------------------------------------------------- |
| `code`                     | `string` | Код локали (например, `'en-US'`).                                                |
| `name`                     | `string` | Английское название локали (например, `'American English'`).                     |
| `nativeName`               | `string` | Название локали на её собственном языке (например, `'American English'`).        |
| `languageCode`             | `string` | Языковой подтег (например, `'en'`).                                              |
| `languageName`             | `string` | Английское название языка (например, `'English'`).                               |
| `nativeLanguageName`       | `string` | Название языка на его собственном языке (например, `'English'`).                 |
| `nameWithRegionCode`       | `string` | Название локали с указанием региона (например, `'English (US)'`).                |
| `nativeNameWithRegionCode` | `string` | Название локали на её собственном языке с указанием региона.                     |
| `regionCode`               | `string` | Региональный подтег (например, `'US'`).                                          |
| `regionName`               | `string` | Английское название региона (например, `'United States'`).                       |
| `nativeRegionName`         | `string` | Название региона на языке локали.                                                |
| `scriptCode`               | `string` | Подтег письменности (например, `'Latn'`).                                        |
| `scriptName`               | `string` | Английское название письменности (например, `'Latin'`).                          |
| `nativeScriptName`         | `string` | Название письменности на языке локали.                                           |
| `maximizedCode`            | `string` | Полностью развёрнутый код локали (например, `'en-Latn-US'`).                     |
| `maximizedName`            | `string` | Английское название развёрнутой локали (например, `'American English (Latin)'`). |
| `nativeMaximizedName`      | `string` | Название развёрнутой локали на её собственном языке.                             |
| `minimizedCode`            | `string` | Минимальный код локали (например, `'en'`).                                       |
| `minimizedName`            | `string` | Английское название сокращённой локали.                                          |
| `nativeMinimizedName`      | `string` | Название сокращённой локали на её собственном языке.                             |
| `emoji`                    | `string` | Флаг или эмодзи, представляющий локаль.                                          |

## Примеры [#examples]

```ts title="handler.js"
// Базовое использование
import { getLocaleProperties } from 'gt-node';

app.get('/api/locale-info', (req, res) => {
  const props = getLocaleProperties('ja');
  res.json({
    name: props.name,             // 'Japanese'
    nativeName: props.nativeName, // '日本語'
    script: props.scriptName,     // 'Japanese'
  });
});
```

## Заметки [#notes]

* Эта функция синхронная — `await` для неё не нужен.
* Полезно при создании селекторов локали или для отображения пользователям метаданных локали.