تحويل JSON إلى TypeScript

مثال

المدخل:

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

الناتج:

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

interface Address {
  city: string;
}

تعيين الأنواع

الحقل الاختياري مقابل الحقل القابل لأن يكون null

• foo?: string، قد يكون هذا الحقل غائبًا عن الكائن، ويُطبَّق فحص undefined.
• foo: string | null، هذا الحقل موجود دائمًا، لكنه قد يكون null بشكل صريح.
• foo?: string | null، قد يكون غائبًا أو null.

لا يحتوي JSON نفسه على undefined، لكن واجهات الـ API تختلف في طريقة الإشارة إلى غياب الحقل. طابِق دلالات الـ API الذي تستخدمه.

• عادةً ما تحذف واجهات REST الحقول المفقودة -> ?:.
• تُعيد GraphQL دائمًا كل حقل مطلوب -> | null.
• تستخدم بعض حزم SDK كلا الأسلوبين في سياقات مختلفة.

أنواع الاتحاد مقابل الأنواع الحرفية

إذا رصدت الأداة الحقل النصي نفسه بمجموعة صغيرة من القيم عبر العينات ("status": "pending"، "active"، "archived")، فيمكنها إخراج اتحاد من الحرفيات النصية:

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

فعِّل خيار «استنتاج اتحادات الحرفيات النصية» إذا رغبت في ذلك.

الأخطاء الشائعة

• الاستنتاج من عينة واحدة. يصبح كل حقل إلزاميًا، ولا يمكن رصد قابلية القيمة لأن تكون null. للحصول على أنواع أفضل، مرِّر من 5 إلى 10 عينات متنوعة.
• المصفوفات الفارغة. لا تعطي "tags": [] أي معلومات عن النوع، فيُخرِج المولّد unknown[]. قدِّم عينة تحتوي على عنصر واحد على الأقل.
• المصفوفات مختلطة الأنواع. تُنتج [1, "two", true] النوع (number | string | boolean)[]. غالبًا ما يعني ذلك أن على JSON أن يُعاد تصميمه بدلًا من تحديد نوعه.
• المفاتيح النصية الرقمية. يظل JSON {"1": "a", "2": "b"} كائنًا في TypeScript (Record<string, string>)، وليس مصفوفة. ويتعامل المولّد مع ذلك بشكل صحيح.