@stdlib/string-kebabcase

Convert a string to kebab case.

Usage no npm install needed!

<script type="module">
  import stdlibStringKebabcase from 'https://cdn.skypack.dev/@stdlib/string-kebabcase';
</script>

README

kebabcase

NPM version Build Status Coverage Status dependencies

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-😀'

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/string-kebabcase

Usage

Usage: kebabcase [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ kebabcase 'hello world!'
hello-world

To use as a standard stream,

$ echo -n 'beEp booP' | kebabcase
beep-boop

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.