toSnakeCase

function toSnakeCase(value: string, options?: ToSnakeCaseOptions): string;

Те же правила, что у kebab-case, но с подчёркиваниями вместо дефисов: пробелы и дефисы становятся подчёркиваниями, подчёркивание вставляется на стыке строчной и заглавной букв, результат приводится к нижнему регистру.

clean убирает всё, кроме букв, цифр и подчёркиваний; trim сначала схлопывает окружающие пробелы.

Параметры

Параметр	Тип	Описание
`value`	`string`	Строка для преобразования. Не должна быть пустой.
`options` (необязательный)	`ToSnakeCaseOptions`	`clean` убирает оставшуюся пунктуацию; `trim` обрезает и схлопывает пробелы.

Возвращает

string — преобразованная строка.

Исключения

Исключение	Условие
`EmptyStringException`	значение не строка или строка пуста.

Примеры

Преобразование

toSnakeCase("Hello World"); // => "hello_world"
toSnakeCase("userFirstName"); // => "user_first_name"

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

Исходный код

src/lang/string/toSnakeCase.ts

23 September 2026

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