toSnakeCase

Converts a string into snake_case format, where words are lowercase and separated by underscores.
> toSnakeCase(str: string): string
Parameters
  • str (string): The input string to be converted into snake_case. It can include mixed cases, numbers, or delimiters (e.g., spaces, dashes, underscores).
  • Returns: A string formatted in snake_case, with all words in lowercase separated by underscores.

Example

import { toSnakeCase } from "string-toolset";

// Convert a regular phrase to snake_case
console.log(toSnakeCase("Hello World")); // "hello_world"

// Handle camelCase
console.log(toSnakeCase("toSnakeCase")); // "to_snake_case"

// Handle PascalCase
console.log(toSnakeCase("ToSnakeCase")); // "to_snake_case"

// Handle kebab-case
console.log(toSnakeCase("to-snake-case")); // "to_snake_case"

// Handle snake_case (idempotent)
console.log(toSnakeCase("already_snake_case")); // "already_snake_case"

// Handle strings with numbers
console.log(toSnakeCase("Chapter1 of the book")); // "chapter1_of_the_book"

// Handle empty input
console.log(toSnakeCase("")); // ""

Use Cases

  • Converting strings for consistent database or API keys.
  • Standardizing text inputs for storage or processing.
  • Creating snake_case identifiers from human-readable strings.