JSON zu TypeScript
Wandle ein JSON-Beispiel in TypeScript-Interfaces oder Type-Aliases um. Verschachtelte Objekte werden zu eigenen benannten Typen. Arrays mit Objekten werden zusammengeführt, sodass Schlüssel, die in einigen Elementen fehlen, optional werden. Unterschiedliche Werte werden zu Union-Typen. Füge eine API-Antwort ein, wähle Interface oder Type und kopiere Deklarationen, die du direkt in deinen Code übernehmen kannst.
Häufig gestellte Fragen
Wie werden verschachtelte Objekte verarbeitet?
Jedes verschachtelte Objekt erhält eine eigene Deklaration, benannt nach dem Schlüssel, unter dem es steht, in PascalCase; aus address wird zum Beispiel Address. Objekte in Arrays werden nach der Einzahl des Array-Schlüssels benannt: aus users wird User und aus categories wird Category. Objekte mit genau denselben Feldern verwenden dieselbe Deklaration.
Wann wird eine Eigenschaft optional?
Wenn ein Array mehrere Objekte enthält und ein Schlüssel in einigen davon fehlt, wird dieser Schlüssel mit einem Fragezeichen als optional gekennzeichnet. Schlüssel, die in jedem Element vorkommen, bleiben erforderlich. Bei einem einzelnen Objekt gibt es keine anderen Beispiele zum Vergleichen, daher sind alle Schlüssel erforderlich.
Wie werden Nullwerte typisiert?
Ein Schlüssel, der in deinem Beispiel null ist, wird als null typisiert. Ist ein Schlüssel in einigen Elementen null und in anderen ein String, wird er zu string | null. Wenn ein Feld in echten Daten null sein kann, in deinem Beispiel aber nie null ist, füge null von Hand hinzu oder füge ein Beispiel ein, das null enthält.
Sollte ich Interface oder Type wählen?
Beide beschreiben dieselbe Struktur. Interfaces lassen sich erweitern und zusammenführen, weshalb viele Styleguides sie für Objektstrukturen bevorzugen. Type-Aliases funktionieren auch für Union-Typen und werden von manchen Teams überall verwendet. Wähle, was deine Codebasis verwendet; die Felder sind identisch.
Wie werden Arrays typisiert?
Ein Array mit Werten eines Typs wird zu diesem Typ mit [] dahinter, etwa string[] oder User[]. Ein Array mit mehreren Typen wird zu einer Union in Klammern, etwa (string | number)[]. Ein leeres Array wird zu unknown[], weil das Beispiel nichts über seine Elemente aussagt.
Was passiert mit Schlüsseln, die keine gültigen Bezeichner sind?
Schlüssel mit Leerzeichen, Bindestrichen oder anderen unzulässigen Zeichen in einem TypeScript-Bezeichner werden in Anführungszeichen gesetzt, zum Beispiel "first-name": string. Das ist gültiges TypeScript und entspricht genau der JSON.
Werden Zahlen als Ganzzahl oder Gleitkommazahl typisiert?
TypeScript kennt nur einen Zahlentyp, daher werden sowohl Ganzzahlen als auch Dezimalzahlen zu number. Wenn du wissen musst, welche Werte Ganzzahlen sind, unterscheidet der JSON Schema Generator zwischen integer und number.
Kann ich den Namen des Wurzeltyps ändern?
Ja. Gib einen Namen für den Wurzeltyp ein, etwa ApiResponse. Er wird in PascalCase umgewandelt, und die verschachtelten Typen behalten die aus ihren Schlüsseln abgeleiteten Namen. Wenn die oberste Ebene deines JSON ein Array oder ein einzelner Wert ist, wird der Wurzeltyp dafür zu einem Type-Alias.
Werden Datumsangaben erkannt?
Nein. JSON kennt keinen Datumstyp, daher ist ein Datum in deinem Beispiel ein String und wird als string typisiert. Wandle es nach dem Parsen in deinem Code in ein Date um oder schränke den Typ von Hand ein, wenn du einen Template-Literal-Typ verwendest.
Wie groß darf das JSON sein?
Bis zu 1,000,000 Zeichen, mit einer Verschachtelungstiefe von bis zu 64 Ebenen. Das Beispiel wird nur analysiert, um die Typen zu erzeugen, und nicht gespeichert.