requireValidLocale

function requireValidLocale(
  value: string | null | undefined,
  message: string = "Expected a valid locale."
): string;

Ровно две латинские буквы в любом регистре — "en", "UK". Код региона или письменности, как в "en-US", не проходит: это короткий код языка, а не полный тег BCP 47.

isX и nonX отвечают на вопрос и никогда не прерывают выполнение; requireX и requireNonX возвращают значение или выбрасывают исключение. Схема разобрана в Соглашения о проверках.

Параметры

Параметр	Тип	Описание
`value`	`string \\| null \\| undefined`	Значение, которое нужно проверить.
`message` (необязательный) `= "Expected a valid locale."`	`string`	Сообщение исключения. Если не задано, используется сообщение по умолчанию.

Возвращает

string — то же значение, уже проверенное как код локали.

Исключения

Исключение	Условие
`IllegalArgumentException`	значение не является кодом локали.

Примеры

Что проходит, а что нет

requireValidLocale("en"); // => "en"
requireValidLocale("UK"); // => "UK"
requireValidLocale("en-US"); // throws IllegalArgumentException
requireValidLocale("eng"); // throws IllegalArgumentException

Смотрите также

Исходный код

src/lang/string/requireValidLocale.ts

23 September 2026

Эта документация сгенерирована нейросетью (Claude) на основе исходного кода библиотеки.