headercase

Convert a string to HTTP header case.

Usage

var headercase = require( '@stdlib/string/headercase' );

headercase( str )

Converts a string to HTTP header case.

var out = headercase( 'foo bar' );
// returns 'Foo-Bar'

out = headercase( 'IS_MOBILE' );
// returns 'Is-Mobile'

out = headercase( 'Hello World!' );
// returns 'Hello-World'

out = headercase( '--foo-bar--' );
// returns 'Foo-Bar'

Examples

var headercase = require( '@stdlib/string/headercase' );

var str = 'Hello World!';
var out = headercase( str );
// returns 'Hello-World'

str = 'HELLO WORLD!';
out = headercase( str );
// returns 'Hello-World'

str = 'To be, or not to be: that is the question.';
out = headercase( str );
// returns 'To-Be-Or-Not-To-Be-That-Is-The-Question'

---

CLI

Usage

Usage: headercase [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\nfoo_bar' | headercase --split /\r?\n/
  
  # Escaped...
  $ echo -n $'beep\nfoo_bar' | headercase --split /\\r?\\n/

• The implementation ignores trailing delimiters.

Examples

$ headercase 'hello world!'
Hello-World

To use as a standard stream,

$ echo -n 'beEp booP' | headercase
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\tfoo_bar' | headercase --split '\t'
Beep
Foo-Bar

---

See Also

• @stdlib/string/camelcase: convert a string to camel case.
• @stdlib/string/kebabcase: convert a string to kebab case.
• @stdlib/string/pascalcase: convert a string to Pascal case.
• @stdlib/string/snakecase: convert a string to snake case.