kebabcase

Convert a string to kebab case.

Installation

npm install @stdlib/string-kebabcase

Usage

var kebabcase = require( '@stdlib/string-kebabcase' );

kebabcase( str )

Converts a string to kebab case.

var str = kebabcase( 'Foo Bar' );
// returns 'foo-bar'

str = kebabcase( 'I am a tiny little house' );
// returns 'i-am-a-tiny-little-house'

str = kebabcase( 'Hello World!' );
// returns 'hello-world'

Examples

var kebabcase = require( '@stdlib/string-kebabcase' );

var str = 'foo bar baz';
var out = kebabcase( str );
// returns 'foo-bar-baz'

str = 'foo_baz';
out = kebabcase( str );
// returns 'foo-baz'

str = 'foo-bar-baz!';
out = kebabcase( str );
// returns 'foo-bar-baz'

str = 'beep    boop!';
out = kebabcase( str );
// returns 'beep-boop'

str = 'foo-baz';
out = kebabcase( str );
// returns 'foo-baz'

str = 'Welcome! 😀';
out = kebabcase( str );
// returns 'welcome-😀'

See Also

• @stdlib/string-kebabcase-cli: CLI package for use as a command-line utility.
• @stdlib/string-camelcase: convert a string to camel case.
• @stdlib/string-constantcase: convert a string to constant case.
• @stdlib/string-pascalcase: convert a string to Pascal case.
• @stdlib/string-snakecase: convert a string to snake case.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.