XML JSON object compare module
npm install diff-js-xml
- Compare elements and element values
- Compare with wildcards for element values
- Clear reporting of differences in result array see below
$ npm install diff-js-xml --save
$3
javascript
const tool = require('diff-js-xml');
tool.diffAsXml(lhsXML, rhsXML, schema, options, (result) => {});
`
Before comparing xml is first transformed into JSON object with xml-js module lhsXML and rhsXML are the two XML strings to compare.
schema options for specific keys for example skip one of them or null if not needed
javascript
const schema = { elementA: { skipKey:true}}
`options generic options or null if not needed current options available:
- compareElementValues to disable comparing of element values default is true
- xml2jsOptions pass through options to xml-js. xml-js has its own default options, and we override a handful:
You can override these, or others, but most option combinations have not been tested carefully so use caution.javascript
const options = {compareElementValues: false}
`result array returned from the diff method containing all the differences with following result types:
missing element xml element is not found in leftXML or rightXML
difference in element value values of elements is not equal
Example of result
[ { path: 'element.subelement',
type: 'difference in field value',
message: 'field element.subelement has lhs value TestA and rhs value TestB' } ]
#### wildcard values
For A-B testing purposes it can be very handy to compare with wildcards if for exammple you are not interested in all
the data. You can put an * in the first (lhs) xml file. The result of this compare will be no differences.
javascript
const lhsxml =
'- *
Chinese French Spanish
const string =
'- Dutch
Chinese French Spanish
`$3
javascript
const tool = require('diff-js-xml');
tool.diff(lhsObject, rhsObject, schema, options, (result) => {});
``