How to use XML to TypeScript
- Paste a representative XML sample, ideally one with all the optional fields filled in.
- Set the name of the root type, and decide whether you want helper code as well or types only.
- Copy the generated TypeScript code into your project.
About XML to TypeScript
Writing model classes by hand for a big XML payload is dull, and it is where typos creep in. Paste a sample here and the generator works out the structure: which fields exist, which are objects, which are arrays and what type each value has. The output is interfaces for every object. Untick "Types only" and a Convert class with runtime checks is added.
XML is first converted to JSON the same way as in our XML to JSON tool: attributes get an @_ prefix and text content next to attributes is called #text. The TypeScript types are generated from that result. An interface only exists at compile time. If you need to check incoming data at runtime, keep the Convert class.
Using the generated code
Cast with const data: Root = JSON.parse(text), or use the generated Convert.toRoot(text) for validation.
Optional properties are written with a question mark, and nullable ones as string | null.