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) на основі вихідного коду бібліотеки.