toSnakeCase

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

Dieselben Regeln wie bei kebab-case, nur mit Unterstrichen statt Bindestrichen: Leerzeichen und Bindestriche werden zu Unterstrichen, an der Grenze von Klein- zu Großbuchstabe kommt ein Unterstrich hinzu, das Ergebnis wird klein geschrieben.

clean entfernt alles außer Buchstaben, Ziffern und Unterstrichen; trim fasst zuvor den umgebenden Leerraum zusammen.

Parameter

Parameter	Typ	Beschreibung
`value`	`string`	Die umzuwandelnde Zeichenkette. Sie darf nicht leer sein.
`options` (optional)	`ToSnakeCaseOptions`	`clean` entfernt die restliche Zeichensetzung; `trim` schneidet Leerraum ab und fasst ihn zusammen.

Rückgabewert

string — die umgewandelte Zeichenkette.

Ausnahmen

Ausnahme	Bedingung
`EmptyStringException`	der Wert ist keine Zeichenkette oder ist leer.

Beispiele

Umwandeln

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

Siehe auch

Quellcode

src/lang/string/toSnakeCase.ts

23 September 2026

Diese Dokumentation wurde mit KI (Claude) aus dem Quellcode der Bibliothek erzeugt.