headercase

Convert a string to Header case.

Installation

npm install @stdlib/string-base-headercase

Alternatively,

To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch.
If you are using Deno, visit the deno branch.
For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

Usage

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

headercase( str )

Converts a string to 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-base-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'

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.

stdlib-js/string-base-headercase