string.ucFirst()

Capitalizes the first character of the given string.

string.ucFirst( string [, doAll [, doLowerIfAllUppercase ] ] )

Returns: String

Argument Description
string
string, required

the input string

doAll
boolean, optional

If true, then every word is capitalized, where a new word is defined as alpha characters that come after whitespace, a dot [.], a dash [-], or (parenthesis).

This is especially useful to clean up user input of names, e.g. converting a string like "susi q. sorgolis" to "Susi Q. Sorgolis"
doLowerIfAllUppercase
boolean, optional

If true, then if the input string contains letters and they are all UPPERCASE, then the input string is first lowercased.

When combined with the doAll argument, this is especially useful to clean user input of names when they are all UPPERCASE,

e.g. converting "SUSI Q. SORGOLIS" to "Susi Q. Sorgolis" while preserving the CaSe if the input is e.g. "Ronald McDonald"

Examples

There are currently no examples for this function

See also