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

startcase

Capitalize the first letter of each word in a string.

Usage

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

startcase( str )

Capitalizes the first letter of each word in a string.

var str = startcase( 'beep boop a foo bar' );
// returns 'Beep Boop A Foo Bar'

Examples

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

var str = startcase( 'beep boop foo bar' );
// returns 'Beep Boop Foo Bar'

str = startcase( 'Beep' );
// returns 'Beep'

str = startcase( 'BeEp' );
// returns 'BeEp'

str = startcase( '$**_beep_BoOp_**$' );
// returns '$**_beep_BoOp_**$'

str = startcase( '' );
// returns ''

---

CLI

Usage

Usage: startcase [options] [<string>]

Options:

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

Examples

$ startcase 'beep boop foo bar'
Beep Boop Foo Bar

To use as a standard stream,

$ echo -n 'beep boop foo bar' | startcase
Beep Boop Foo Bar 

---

See Also

• @stdlib/string/lowercase: convert a string to lowercase.
• @stdlib/string/uppercase: convert a string to uppercase.