moddle-xml

Read and write XML documents described with moddle.

Usage

Get the libray via npm

npm install --save moddle-xml

Bootstrap

Create a moddle instance

1import { Moddle } from 'moddle';
2import {
3  Reader,
4  Writer
5} from 'moddle-xml';
6
7const model = new Moddle([ myPackage ]);

Read XML

Use the reader to parse XML into an easily accessible object tree:

1const model; // previously created
2
3const xml =
4  '<my:root xmlns:props="http://mypackage">' +
5    '<my:car id="Car_1">' +
6      '<my:engine power="121" fuelConsumption="10" />' +
7    '</my:car>' +
8  '</my:root>';
9
10const reader = new Reader(model);
11const rootHandler = reader.handler('my:Root');
12
13// when
14try {
15  const {
16    rootElement: cars,
17    warnings
18  } = await reader.fromXML(xml, rootHandler);
19
20  if (warnings.length) {
21    console.log('import warnings', warnings);
22  }
23
24  console.log(cars);
25
26  // {
27  //  $type: 'my:Root',
28  //  cars: [
29  //    {
30  //      $type: 'my:Car',
31  //      id: 'Car_1',
32  //      engine: [
33  //        { $type: 'my:Engine', powser: 121, fuelConsumption: 10 }
34  //      ]
35  //    }
36  //  ]
37  // }
38
39} catch (err) {
40  console.log('import error', err, err.warnings);
41}

Write XML

Use the writer to serialize the object tree back to XML:

1var model; // previously created
2
3var cars = model.create('my:Root');
4cars.get('cars').push(model.create('my:Car', { power: 10 }));
5
6var options = { format: false, preamble: false };
7var writer = new Writer(options);
8
9var xml = writer.toXML(bar);
10
11console.log(xml); // <my:root xmlns:props="http://mypackage"> ... <my:car power="10" /></my:root>

License

MIT