toKebabCase

function toKebabCase(value: string, options: ToKebabCaseOptions = {}): string;

Leerzeichen und Unterstriche werden zu Bindestrichen, an der Grenze von Klein- zu Großbuchstabe kommt ein Bindestrich hinzu, und das Ergebnis wird klein geschrieben. Die zweite Regel zerlegt "userFirstName" in drei Wörter.

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

Parameter

Parameter	Typ	Beschreibung
`value`	`string`	Die umzuwandelnde Zeichenkette. Sie darf nicht leer sein.
`options` (optional) `= {}`	`ToKebabCaseOptions`	`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

toKebabCase("Hello World"); // => "hello-world"
toKebabCase("userFirstName"); // => "user-first-name"

Siehe auch

Quellcode

src/lang/string/toKebabCase.ts

23 September 2026

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