JSON naar TypeScript

Voorbeeld

Invoer:

{ "id": 1, "name": "Alice", "age": null, "tags": ["admin", "user"], "address": { "city": "Madrid" } }

Uitvoer:

interface User {
  id: number;
  name: string;
  age: number | null;
  tags: string[];
  address: Address;
}

interface Address {
  city: string;
}

Typetoewijzing

Optioneel veld versus nullable veld

• foo?: string, het veld kan ontbreken in het object. Er geldt een undefined-controle.
• foo: string | null, het veld is altijd aanwezig, maar kan expliciet null zijn.
• foo?: string | null, kan ontbreken OF null zijn.

JSON zelf kent geen undefined, maar API’s geven afwezigheid op verschillende manieren aan. Stem dit af op de semantiek van uw API.

• REST-API’s laten ontbrekende velden doorgaans weg -> ?:.
• GraphQL retourneert altijd elk opgevraagd veld -> | null.
• Sommige SDK’s gebruiken beide in verschillende contexten.

Uniontypen versus letterlijke typen

Als de tool ziet dat hetzelfde tekenreeksveld in de voorbeelden slechts een kleine set waarden aanneemt ("status": "pending", "active", "archived"), kan hij een union van tekenreeksliteralen genereren:

status: "pending" | "active" | "archived";

Schakel “unions van tekenreeksliteralen afleiden” in als u dit wilt.

Veelgemaakte fouten

• Afleiden uit één voorbeeld. Elk veld wordt verplicht; nullbaarheid kan niet worden waargenomen. Geef voor betere typen 5-10 gevarieerde voorbeelden op.
• Lege arrays. "tags": [] geeft geen typeinformatie, de generator produceert unknown[]. Geef een voorbeeld met ten minste één element.
• Arrays met gemengde typen. [1, "two", true] levert (number | string | boolean)[] op. Meestal betekent dit dat de JSON beter opnieuw kan worden ontworpen dan getypeerd.
• Numerieke tekenreekssleutels. JSON {"1": "a", "2": "b"} is in TypeScript nog steeds een object (Record<string, string>), geen array. De generator verwerkt dit correct.