jsonecho

JSON to TypeScript

Plak een JSON-voorbeeld en krijg er TypeScript-types voor.

De tool wordt geladen...

Zo gebruik je JSON to TypeScript

  1. Plak een representatief JSON-voorbeeld, bij voorkeur een met alle optionele velden ingevuld.
  2. Stel de naam van het roottype in en bepaal of je ook hulpcode wilt of alleen types.
  3. Kopieer de gegenereerde TypeScript-code naar je project.

Over JSON to TypeScript

Modelklassen met de hand schrijven voor een grote JSON-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.

Een interface bestaat alleen tijdens het compileren. Moet je binnenkomende gegevens tijdens runtime controleren, behoud dan de Convert-klasse. Alles draait in je browser, dus je voorbeeldgegevens blijven op je computer.

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.

Veelgestelde vragen

Waarvan hangt de gegenereerde TypeScript-code af?

De uitvoer bestaat uit interfaces voor elk object. Haal het vinkje bij "Alleen types" weg en er wordt een Convert-klasse met runtimecontroles toegevoegd.

Hoe parseer ik JSON met het resultaat?

Cast met const data: Root = JSON.parse(text), of gebruik de gegenereerde Convert.toRoot(text) voor validatie.

Hoe worden optionele en ontbrekende velden behandeld?

Optionele properties worden met een vraagteken geschreven en properties die null kunnen zijn als string | null.

Kijkt de generator naar meer dan één record?

Hij kent alleen wat in je voorbeeld staat. Ontbreekt een veld in je voorbeeld, dan verschijnt het niet in de types, en is een waarde in je voorbeeld null, dan is het type onbekend. Plak een voorbeeld waarin zoveel mogelijk velden zijn ingevuld, of plak een array met meerdere verschillende records.

Wordt mijn JSON naar een server gestuurd?

Nee. De generator wordt de eerste keer dat je hem gebruikt naar je browser gedownload, ongeveer 1 MB, en alles draait lokaal.

Meer in Data naar klasse

Alle tools →