Home

function: zipObjectDeep

zipObjectDeep(props: Array, values: Array): Object

zipObjectDeep.js, line 18

This method is like `zipObject` except that it supports property paths.

Example(s):

zipObjectDeep(['a.b[0].c', 'a.b[1].d'], [1, 2])
// => { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } }

Params:

Name Type Attribute Description
props The property identifiers.
values The property values.

Returns:

Object 

  {
    "comment": "/**\r\n * This method is like `zipObject` except that it supports property paths.\r\n *\r\n * @since 4.1.0\r\n * @category Array\r\n * @param {Array} [props=[]] The property identifiers.\r\n * @param {Array} [values=[]] The property values.\r\n * @returns {Object} Returns the new object.\r\n * @see unzip, unzipWith, zip, zipObject, zipWith\r\n * @example\r\n *\r\n * zipObjectDeep(['a.b[0].c', 'a.b[1].d'], [1, 2])\r\n * // => { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } }\r\n */",
    "meta": {
        "range": [
            560,
            662
        ],
        "filename": "zipObjectDeep.js",
        "lineno": 18,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100011888",
            "name": "zipObjectDeep",
            "type": "FunctionDeclaration",
            "paramnames": [
                "props",
                "values"
            ]
        }
    },
    "description": "This method is like `zipObject` except that it supports property paths.",
    "since": "4.1.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "Array",
            "value": "Array"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "Array"
                ]
            },
            "optional": true,
            "defaultvalue": "[]",
            "description": "The property identifiers.",
            "name": "props"
        },
        {
            "type": {
                "names": [
                    "Array"
                ]
            },
            "optional": true,
            "defaultvalue": "[]",
            "description": "The property values.",
            "name": "values"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "Object"
                ]
            },
            "description": "Returns the new object."
        }
    ],
    "see": [
        "unzip, unzipWith, zip, zipObject, zipWith"
    ],
    "examples": [
        "zipObjectDeep(['a.b[0].c', 'a.b[1].d'], [1, 2])\r// => { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } }"
    ],
    "name": "zipObjectDeep",
    "longname": "zipObjectDeep",
    "kind": "function",
    "scope": "global",
    "___id": "T000002R001074",
    "___s": true,
    "filepath": "zipObjectDeep.js"
}