time-to-botec/js/node_modules/@stdlib/string/camelcase/README.md

camelcase

Convert a string to camel case.

Usage

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

camelcase( str )

Converts a string to camel case.

var out = camelcase( 'foo bar' );
// returns 'fooBar'

out = camelcase( 'IS_MOBILE' );
// returns 'isMobile'

out = camelcase( 'Hello World!' );
// returns 'helloWorld'

out = camelcase( '--foo-bar--' );
// returns 'fooBar'

Examples

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

var str = 'Hello World!';
var out = camelcase( str );
// returns 'helloWorld'

str = 'HELLO WORLD!';
out = camelcase( str );
// returns 'helloWorld'

str = 'To be, or not to be: that is the question.';
out = camelcase( str );
// returns 'toBeOrNotToBeThatIsTheQuestion'

---

CLI

Usage

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

• The implementation ignores trailing delimiters.

Examples

$ camelcase 'hello world!'
helloWorld

To use as a standard stream,

$ echo -n 'beEp booP' | camelcase
beEpBooP

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\nfoo_bar' | camelcase --split '\t'
beep
fooBar

---

See Also

• @stdlib/string/constantcase: convert a string to constant case.
• @stdlib/string/kebabcase: convert a string to kebab case.
• @stdlib/string/snakecase: convert a string to snake case.