Home

constant: assignWith


  {
    "comment": "/**\r\n * This method is like `assign` except that it accepts `customizer`\r\n * which is invoked to produce the assigned values. If `customizer` returns\r\n * `undefined`, assignment is handled by the method instead. The `customizer`\r\n * is invoked with five arguments: (objValue, srcValue, key, object, source).\r\n *\r\n * **Note:** This method mutates `object`.\r\n *\r\n * @since 4.0.0\r\n * @category Object\r\n * @param {Object} object The destination object.\r\n * @param {...Object} sources The source objects.\r\n * @param {Function} [customizer] The function to customize assigned values.\r\n * @returns {Object} Returns `object`.\r\n * @see assignInWith\r\n * @example\r\n *\r\n * function customizer(objValue, srcValue) {\r\n *   return isUndefined(objValue) ? srcValue : objValue\r\n * }\r\n *\r\n * const defaults = partialRight(assignWith, customizer)\r\n *\r\n * defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 })\r\n * // => { 'a': 1, 'b': 2 }\r\n */",
    "meta": {
        "range": [
            1066,
            1197
        ],
        "filename": "assignWith.js",
        "lineno": 31,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100000108",
            "name": "assignWith",
            "type": "CallExpression",
            "value": ""
        }
    },
    "description": "This method is like `assign` except that it accepts `customizer`\rwhich is invoked to produce the assigned values. If `customizer` returns\r`undefined`, assignment is handled by the method instead. The `customizer`\ris invoked with five arguments: (objValue, srcValue, key, object, source).\r\r**Note:** This method mutates `object`.",
    "since": "4.0.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "Object",
            "value": "Object"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "Object"
                ]
            },
            "description": "The destination object.",
            "name": "object"
        },
        {
            "type": {
                "names": [
                    "Object"
                ]
            },
            "variable": true,
            "description": "The source objects.",
            "name": "sources"
        },
        {
            "type": {
                "names": [
                    "function"
                ]
            },
            "optional": true,
            "description": "The function to customize assigned values.",
            "name": "customizer"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "Object"
                ]
            },
            "description": "Returns `object`."
        }
    ],
    "see": [
        "assignInWith"
    ],
    "examples": [
        "function customizer(objValue, srcValue) {\r  return isUndefined(objValue) ? srcValue : objValue\r}\r\rconst defaults = partialRight(assignWith, customizer)\r\rdefaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 })\r// => { 'a': 1, 'b': 2 }"
    ],
    "name": "assignWith",
    "longname": "assignWith",
    "kind": "constant",
    "scope": "global",
    "___id": "T000002R000010",
    "___s": true,
    "filepath": "assignWith.js"
}