Home

function: upperCase

upperCase(string: string): string

upperCase.js, line 22

Converts `string`, as space separated words, to upper case.

Example(s):

upperCase('--foo-bar')
// => 'FOO BAR'

upperCase('fooBar')
// => 'FOO BAR'

upperCase('__foo_bar__')
// => 'FOO BAR'

Params:

Name Type Attribute Description
string The string to convert.

Returns:

string 

  {
    "comment": "/**\r\n * Converts `string`, as space separated words, to upper case.\r\n *\r\n * @since 4.0.0\r\n * @category String\r\n * @param {string} [string=''] The string to convert.\r\n * @returns {string} Returns the upper cased string.\r\n * @see camelCase, kebabCase, lowerCase, snakeCase, startCase, upperFirst\r\n * @example\r\n *\r\n * upperCase('--foo-bar')\r\n * // => 'FOO BAR'\r\n *\r\n * upperCase('fooBar')\r\n * // => 'FOO BAR'\r\n *\r\n * upperCase('__foo_bar__')\r\n * // => 'FOO BAR'\r\n */",
    "meta": {
        "range": [
            505,
            681
        ],
        "filename": "upperCase.js",
        "lineno": 22,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100011545",
            "name": "upperCase",
            "type": "ArrowFunctionExpression"
        },
        "vars": {
            "": null
        }
    },
    "description": "Converts `string`, as space separated words, to upper case.",
    "since": "4.0.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "String",
            "value": "String"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "string"
                ]
            },
            "optional": true,
            "defaultvalue": "''",
            "description": "The string to convert.",
            "name": "string"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "string"
                ]
            },
            "description": "Returns the upper cased string."
        }
    ],
    "see": [
        "camelCase, kebabCase, lowerCase, snakeCase, startCase, upperFirst"
    ],
    "examples": [
        "upperCase('--foo-bar')\r// => 'FOO BAR'\r\rupperCase('fooBar')\r// => 'FOO BAR'\r\rupperCase('__foo_bar__')\r// => 'FOO BAR'"
    ],
    "name": "upperCase",
    "longname": "upperCase",
    "kind": "function",
    "scope": "global",
    "___id": "T000002R001047",
    "___s": true,
    "filepath": "upperCase.js"
}