How to deserialize XML to JavaScript/TypeScript?

Question

I get a XML structure that contains information about an Appointment.

My code:

function AppointmentCallback(appointment : any) {
}

I want to convert this in an object in JavaScript or TypeScript(preferred). In jQuery there's only the parseXML method which makes the opposite from what I need.

Is there any library that makes this possible?

Thanks in advance!

Are you doing this in the browser or with node.js or something else? — Benjamin Kovach
– Benjamin Kovach, Commented Jul 10, 2014 at 14:00
uhm.. parseXML converts xml to a javascript object. What else could you possibly be looking for? — user400654
– user400654, Commented Jul 10, 2014 at 14:01
@Benjamin Kovach In the browser. @Kevin B On the jquery page link it says that it returns a XML Document. Description: Parses a string into an XML document. I want it to create an object from xml. — diiiz_
– diiiz_, Commented Jul 10, 2014 at 14:11
@KevinB Actually it converts XML to a DOM. Obviously these are JavaScript objects, but they contain sufficient metadata to accurately reconstruct the original document, e.g., by preserving node ordering. Converting to plain old JavaScript objects, which $.parseXML doesn't do, would lose this information. If all you want to do is consume, that might not matter though. My answer below runs through the options, but the POJO route is probably best served by JXON: developer.mozilla.org/en-US/docs/Archive/…. — Bart Read
– Bart Read, Commented May 6, 2016 at 18:57
Some recommendations on how to convert xml to json can be found on this question. — doubleDown
– doubleDown, Commented Aug 20, 2017 at 15:35

jjrv · Accepted Answer · 2016-03-03 12:16:15Z

8

cxml can parse XML into JSON and also fire handlers during parsing to process a file as it loads. You can compile .xsd schema files to TypeScript .d.ts definition files using cxsd. The parsed output will also be fully typed so an IDE like Atom or the tsc compiler can check that you're correctly handling the parsed JSON (element and attribute names and data types etc.)

Here's what using it looks like (more examples in Github):

import * as cxml from 'cxml';
import * as example from 'cxml/test/xmlns/dir-example';

var parser = new cxml.Parser();
var result = parser.parse('<dir name="empty"></dir>', example.document);

result.then((doc: example.document) => {
    console.log(JSON.stringify(doc, null, 2));
});

answered Mar 3, 2016 at 12:16

jjrv

4,3653 gold badges44 silver badges56 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

ItamarG3 · Accepted Answer · 2017-08-09 12:14:12Z

2

MDN has a good article on XML serialization and deserialisation in JavaScript, which covers all the options without having to resort to libraries such as jQuery.

Older versions of IE (pre-11) - and the current version of Opera Mini - have some limitations that may cause problems if you need to support them. Notably DOMParser.parseFromString is missing: Check this.

If you really do want to convert to JavaScript objects rather than work with a DOM, probably what you want to look at is JXON. Here's the way.

Note that if you want to recreate your XML document from objects at any point, I'd recommend you convert it to a DOM and work directly with the DOM nodes. That way, when you reserialize it, the ordering of nodes will be preserved. If you go down the plain old JavaScript object route, ordering will be lost.

edited Aug 9, 2017 at 12:14

ItamarG3

4,1226 gold badges33 silver badges44 bronze badges

answered May 6, 2016 at 18:54

Bart Read

2,7773 gold badges22 silver badges33 bronze badges

2 Comments

Искрен Станиславов Over a year ago

does this provide code completion on the generated object?

Dragas Over a year ago

You're not supposed to work with DOM when you work with XML.

Moriarty · Accepted Answer · 2017-08-02 15:46:09Z

1

Check out the cxsd library https://www.npmjs.com/package/cxsd it parses xsd to typescript. It has some odd dependencies. I had to do an npm install --global --production windows-build-tools also make sure cxsd.cmd is included the PATH it is a cli cxsd file.xsd it outputs a .d.ts file with the generated typescript

edited Aug 2, 2017 at 15:46

answered Aug 1, 2017 at 19:56

Moriarty

5356 silver badges20 bronze badges

Comments

zahma · Accepted Answer · 2017-08-09 11:44:50Z

0

You can also use serializeXmlNode from JSONconvert

as follow: Jsonconvert(doc)

answered Aug 9, 2017 at 11:44

zahma

4224 silver badges17 bronze badges

1 Comment

ironchicken Over a year ago

This answer seems to refer to a C# library. The question is about TypeScript.

Collectives™ on Stack Overflow

How to deserialize XML to JavaScript/TypeScript?

4 Answers 4

Comments

2 Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

2 Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related