JSON do TypeScript

Przykład

Wejście:

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

Wyjście:

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

interface Address {
  city: string;
}

Mapowanie typów

Pole opcjonalne a pole dopuszczające null

• foo?: string, to pole może nie występować w obiekcie. Obowiązuje sprawdzanie undefined.
• foo: string | null, to pole jest zawsze obecne, ale może być jawnie równe null.
• foo?: string | null, może nie występować LUB być równe null.

Sam JSON nie ma undefined, ale różne API sygnalizują brak pola na różne sposoby. Dostosuj to do semantyki swojego API.

• API REST zwykle pomijają brakujące pola -> ?:.
• GraphQL zawsze zwraca każde żądane pole -> | null.
• Niektóre SDK używają obu podejść w różnych kontekstach.

Typy unii a typy literałowe

Jeśli narzędzie zauważy, że to samo pole tekstowe przyjmuje w próbkach jedynie niewielki zbiór wartości ("status": "pending", "active", "archived"), może wygenerować unię literałów tekstowych:

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

Włącz „wnioskuj unie literałów tekstowych”, jeśli tego chcesz.

Częste błędy

• Wnioskowanie z jednej próbki. Każde pole staje się wymagane; nie można zaobserwować dopuszczalności null. Aby uzyskać lepsze typy, podaj 5-10 zróżnicowanych próbek.
• Puste tablice. "tags": [] nie dostarcza informacji o typie, generator zwraca unknown[]. Podaj próbkę zawierającą co najmniej jeden element.
• Tablice o mieszanych typach. [1, "two", true] daje (number | string | boolean)[]. Zwykle oznacza to, że JSON należałoby przeprojektować, a nie typować w obecnej postaci.
• Klucze będące ciągami liczbowymi. JSON {"1": "a", "2": "b"} jest w TypeScript nadal obiektem (Record<string, string>), a nie tablicą. Generator obsługuje to poprawnie.