ArrayMode Support

Array mode is the most wanted feature in XML to JSON parser. Check the example to understand the need;

<report>
        <store>
            <region>US</region>
            <inventory>
                <item>
                    <name>Banana</name>
                    <count>200</count>
                </item>
                <item>
                    <name>Apple</name>
                    <count>100</count>
                </item>
            </inventory>
        </store>
        <store>
            <region>EU</region>
            <inventory>
                <item>
                    <name>Banana</name>
                    <count>100</count>
                </item>
            </inventory>
        </store>
    </report>

Parsed response

{
  "report": {
    "store": [
      {
        "region": "US",
        "inventory": {
          "item": [
            {
              "name": "Banana",
              "count": "200"
            },
            {
              "name": "Apple",
              "count": "100"
            }
          ]
        }
      },
      {
        "region": "EU",
        "inventory": {
          "item": {
            "name": "Banana",
            "count": "100"
          }
        }
      }
    ]
  }
}

When the occurence of a tag is 1 it is parsed as an objectg otherwise array. In this case, user need an extra check to traverse through the parser response to confirm if he value of a tag is array type or object type.

I have solved this problem by introducing arrayMode option.

const jsObj = parser.parse(xmlData, {
      arrayMode: true
});

When arrayMode: true, it parses all tags as array if they have nested tags.

{
            "report": [
                {
                    "store": [
                        {
                            "region": "US",
                            "inventory": [
                                {
                                    "item": [
                                        {
                                            "name": "Banana",
                                            "count": 200
                                        },
                                        {
                                            "name": "Apple",
                                            "count": 100
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "region": "EU",
                            "inventory": [
                                {
                                    "item": [
                                        {
                                            "name": "Banana",
                                            "count": 100
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }

When arrayMode: 'strict', it parses all tags as array.

 {
            "report": [
                {
                    "store": [
                        {
                            "region": ["US"],
                            "inventory": [
                                {
                                    "item": [
                                        {
                                            "name": ["Banana"],
                                            "count": [200]
                                        },
                                        {
                                            "name": ["Apple"],
                                            "count": [100]
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "region": ["EU"],
                            "inventory": [
                                {
                                    "item": [
                                        {
                                            "name": [ "Banana" ],
                                            "count": [100]
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }

It’ll look like as follow in case of node text, attribute, and CDATA

"item": [
    {
        "#text": "some item detail",
        "@_grade": "A",
        "name": "Banana",
        "count": 200
    },
    {
        "@_grade": "B",
        "__cdata": "som text",
        "name": "Apple",
        "count": 100
    }
]

or in strict mode

"item": [{
    "#text": [ "some item detail"  ],
    "@_grade": [ "A"  ],
    "name": [ "Banana"  ],
    "count": [ 200  ]
},{
    "@_grade": [ "B"  ],
    "__cdata": [ "som text"  ],
    "name": [ "Apple"  ],
    "count": [ 100 ]
    }
]

Please let us know if you think that the parsing output should be different.

[jyte]

It worked well for my 800MB file, thx 😃

[amitguptagwl]

@LihiJosef Try isArray option of FXPv4.

isArray: (name, jpath, isLeafNode, isAttribute) => { 
        if( name === "inventory") return true;
    }