JSON'dan TypeScript'e

Örnek

Giriş:

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

Çıktı:

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

interface Address {
  city: string;
}

Tip eşlemesi

İsteğe bağlı alan ile null olabilen alan

• foo?: string, bu alan nesnede bulunmayabilir. undefined denetimi uygulanır.
• foo: string | null, bu alan her zaman vardır, ancak açıkça null olabilir.
• foo?: string | null, bulunmayabilir VEYA null olabilir.

JSON’ın kendisinde undefined yoktur; ancak API’ler alan yokluğunu farklı şekillerde bildirir. Kullandığınız API’nin anlamlarıyla eşleştirin.

• REST API’ler genellikle eksik alanları atlar -> ?:.
• GraphQL istenen her alanı her zaman döndürür -> | null.
• Bazı SDK’ler farklı bağlamlarda her ikisini de kullanır.

Birleşim tipleri ile literal tipler

Araç, aynı karakter dizisi alanının örnekler boyunca yalnızca küçük bir değer kümesi aldığını görürse ("status": "pending", "active", "archived"), bir karakter dizisi literal birleşimi üretebilir:

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

Bunu istiyorsanız “karakter dizisi literal birleşimlerini çıkarım” seçeneğini etkinleştirin.

Yaygın hatalar

• Tek bir örnekten çıkarım yapmak. Her alan zorunlu hâle gelir; null olabilirlik gözlemlenemez. Daha iyi tipler için 5-10 çeşitli örnek verin.
• Boş diziler. "tags": [] hiçbir tip bilgisi vermez, üretici unknown[] çıkarır. En az bir öğe içeren bir örnek sağlayın.
• Karışık tipli diziler. [1, "two", true] şunu üretir: (number | string | boolean)[]. Bu genellikle JSON’ın tiplenmesi yerine yeniden tasarlanması gerektiği anlamına gelir.
• Sayısal karakter dizisi anahtarları. JSON {"1": "a", "2": "b"} TypeScript’te hâlâ bir nesnedir (Record<string, string>), dizi değildir. Üretici bunu doğru şekilde işler.