requireValidSlug

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

Начинается с буквы, дальше буквы, цифры, дефисы и подчёркивания — форма, годная для сегмента URL или ключа. Пробелы, цифра в начале и пустая строка не проходят.

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

Параметры

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

Возвращает

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

Исключения

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

Примеры

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

requireValidSlug("my-page"); // => "my-page"
requireValidSlug("a_1"); // => "a_1"
requireValidSlug("1-page"); // throws IllegalArgumentException
requireValidSlug("my page"); // throws IllegalArgumentException

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

Исходный код

src/lang/string/requireValidSlug.ts

23 September 2026

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