Zo gebruik je XML to TypeScript
- Plak een representatief XML-voorbeeld, bij voorkeur een met alle optionele velden ingevuld.
- Stel de naam van het roottype in en bepaal of je ook hulpcode wilt of alleen types.
- Kopieer de gegenereerde TypeScript-code naar je project.
Over XML to TypeScript
Modelklassen met de hand schrijven voor een grote XML-payload is saai en daar sluipen typefouten in. Plak hier een voorbeeld en de generator leidt de structuur af: welke velden er zijn, welke objecten zijn, welke arrays en welk type elke waarde heeft. De uitvoer bestaat uit interfaces voor elk object. Haal het vinkje bij "Alleen types" weg en er wordt een Convert-klasse met runtimecontroles toegevoegd.
XML wordt eerst op dezelfde manier naar JSON geconverteerd als in onze XML to JSON-tool: attributen krijgen een @_-voorvoegsel en tekstinhoud naast attributen heet #text. De TypeScript-types worden uit dat resultaat gegenereerd. Een interface bestaat alleen tijdens het compileren. Moet je binnenkomende gegevens tijdens runtime controleren, behoud dan de Convert-klasse.
De gegenereerde code gebruiken
Cast met const data: Root = JSON.parse(text), of gebruik de gegenereerde Convert.toRoot(text) voor validatie.
Optionele properties worden met een vraagteken geschreven en properties die null kunnen zijn als string | null.