Home

constant: upperFirst


  {
    "comment": "/**\r\n * Converts the first character of `string` 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 converted string.\r\n * @see camelCase, kebabCase, lowerCase, snakeCase, startCase, upperCase\r\n * @example\r\n *\r\n * upperFirst('fred')\r\n * // => 'Fred'\r\n *\r\n * upperFirst('FRED')\r\n * // => 'FRED'\r\n */",
    "meta": {
        "range": [
            464,
            507
        ],
        "filename": "upperFirst.js",
        "lineno": 19,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100011587",
            "name": "upperFirst",
            "type": "CallExpression",
            "value": ""
        }
    },
    "description": "Converts the first character of `string` 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 converted string."
        }
    ],
    "see": [
        "camelCase, kebabCase, lowerCase, snakeCase, startCase, upperCase"
    ],
    "examples": [
        "upperFirst('fred')\r// => 'Fred'\r\rupperFirst('FRED')\r// => 'FRED'"
    ],
    "name": "upperFirst",
    "longname": "upperFirst",
    "kind": "constant",
    "scope": "global",
    "___id": "T000002R001049",
    "___s": true,
    "filepath": "upperFirst.js"
}