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

Uncapitalize

Uncapitalize the first character of a string.

Usage

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

uncapitalize( str )

Uncapitalizes the first character of a string.

var out = uncapitalize( 'Last man standing' );
// returns 'last man standing'

out = uncapitalize( 'Hidden Treasures' );
// returns 'hidden Treasures'

Examples

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

var out = uncapitalize( 'Last man standing' );
// returns 'last man standing'

out = uncapitalize( 'Presidential election' );
// returns 'presidential election'

out = uncapitalize( 'JavaScript' );
// returns 'javaScript'

out = uncapitalize( 'Hidden Treasures' );
// returns 'hidden Treasures'

---

CLI

Usage

Usage: uncapitalize [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\nBoop' | uncapitalize --split /\r?\n/
  
  # Escaped...
  $ echo -n $'Beep\nBoop' | uncapitalize --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ uncapitalize Beep
beep

To use as a standard stream,

$ echo -n 'Beep' | uncapitalize
beep

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\tBOOP' | uncapitalize --split '\t'
beep
bOOP

---

See Also

• @stdlib/string/capitalize: capitalize the first character in a string.
• @stdlib/string/lowercase: convert a string to lowercase.