time-to-botec/squiggle/node_modules/@stdlib/string/kebabcase/README.md

kebabcase

Convert a string to kebab case.

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

Usage

Usage: kebabcase [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

Notes

• If the split separator is a regular expression, ensure that the split option is either properly escaped or enclosed in quotes.

  # Not escaped...
  $ echo -n $'beEp booP\nisMobile' | kebabcase --split /\r?\n/
  
  # Escaped...
  $ echo -n $'beEp booP\nisMobile' | kebabcase --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ kebabcase 'hello world!'
hello-world

To use as a standard stream,

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

By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

$ echo -n 'beep_boop\tisMobile' | kebabcase --split '\t'
beep-boop
is-mobile

---

See Also

• @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.