# General Translation Platform: isValidLocale
URL: https://generaltranslation.com/ru/docs/platform/core/reference/utility-functions/locales/is-valid-locale.mdx
---

title: isValidLocale
description: Проверяет, является ли значение допустимым кодом локали без экземпляра GT. Справочник API для isValidLocale.

---

[`isValidLocale`](/docs/platform/core/reference/gt-class-methods/locales/is-valid-locale) — это автономная служебная функция из основной библиотеки General Translation, которая проверяет, является ли строка допустимым кодом локали BCP-47. Она выполняет проверку формата без экземпляра GT.

## Обзор [#overview]

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

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

console.log(isValidLocale('en-US')); // true
console.log(isValidLocale('invalid')); // false
```

Сигнатура:

```typescript
isValidLocale(locale: string, customMapping?: CustomMapping): boolean
```

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

* **Проверка формата.** Проверяет формат кода локали BCP-47. Это исключительно проверка формата — сетевые запросы не выполняются.
* **Пользовательское сопоставление.** Работает с пользовательскими сопоставлениями локалей, поэтому алиасы, определённые в [`customMapping`](/docs/platform/core/reference/types/custom-mapping), считаются допустимыми.
* **Без состояния.** Подходит для вспомогательных библиотек и проверки пользовательского ввода.

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

| Параметр                           | Описание                                                  | Тип                                                                   | Необязателен | По умолчанию |
| ---------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------- | ------------ | ------------ |
| [`locale`](#locale)                | Значение, которое нужно проверить.                        | `string`                                                              | Нет          | —            |
| [`customMapping`](#custom-mapping) | Пользовательское сопоставление, учитываемое при проверке. | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Да           | —            |

### `locale` [#locale]

**Тип** `string` · **Обязательный**

Значение, которое проверяется как код локали BCP-47.

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

**Тип** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Необязательно**

Необязательное пользовательское сопоставление, алиасы которого считаются допустимыми.

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

**Тип** `boolean`

`true`, если код локали корректен, иначе `false`.

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

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

// Допустимые коды локали
console.log(isValidLocale('en-US')); // true
console.log(isValidLocale('zh-CN')); // true
console.log(isValidLocale('es')); // true

// Недопустимые коды локали
console.log(isValidLocale('invalid')); // false
console.log(isValidLocale('en_US')); // false (подчёркивание вместо дефиса)
console.log(isValidLocale('')); // false
```

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

* Проверяет формат кода локали BCP-47.
* Работает с пользовательскими сопоставлениями локалей.
* Подходит для проверки пользовательского ввода.
* Без сетевых запросов — только проверка формата.
* Функция без состояния, подходящая для вспомогательных библиотек.