API
@agape/string

toSnakeCase Function

Converts a string to snake_case.

API

function toSnakeCase(  input: string): string

toSnakeCase

string

Converts a string to snake_case.

@paraminput:  string
A string to be converted to snake_case.
@returnsstring

Description

Converts a string to snake_case.

Replaces spaces, dashes, and camelCase transitions with underscores, removes special characters, preserves embedded version tokens (like "v2"), and lowercases the result.

Usage

toSnakeCase("hello world"); // "hello_world"

toSnakeCase("UserProfileV2"); // "user_profile_v2"

toSnakeCase("HTML5 Parser"); // "html_5_parser"

toSnakeCase("  messy-input_string  "); // "messy_input_string"

toSnakeCase("ReportV3Final"); // "report_v3_final"

Resources