تقرأ هذه الأداة قيمة JSON وتكتب لها تعريفات interface في TypeScript. تبقى المفاتيح كما هي تمامًا؛ وتُدمج مصفوفات الكائنات في interface واحدة، وتحصل المفاتيح الموجودة في بعض العناصر فقط على ?، وتصبح القيم المختلطة أنواع اتحاد (union).
استخدمها لتحديد أنواع استجابات fetch أو axios في الواجهة الأمامية، أو لتعريف أنواع الإرجاع لمسارات API في Next.js أو handlers في Express، أو كلما كانت الخلفية لا توثّق إلا أمثلة استجابات دون تعريفات أنواع.
اسم النوع (مثل ChannelHistory)؛ ويُحفظ في الرابط على شكل ?name=.types.ts واستخدمه عبر import type { ChannelHistory } from "./types".{
"channel": "general",
"messages": [
{ "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
{ "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
],
"cursor": 42
}export interface ChannelHistory {
channel: string;
messages: Message[];
cursor: number;
}
export interface Message {
id: string;
user: string;
text: string | null;
reactions?: string[];
edited?: boolean;
attachment?: Attachment;
}
export interface Attachment {
type: string;
url: string;
}
تُدمج الرسالتان في interface واحدة باسم Message؛ وreactions وedited وattachment تظهر في إحداهما فقط، فتحصل على ?. ويخلط text بين سلسلة نصية وnull، فيعطي string | null. وتأخذ واجهات العناصر صيغة المفرد من المفتاح (messages → Message).
export interface، جاهز للاستيراد في مكان آخر."a-b"، "2fa") تُقتبس.?:).string | number)؛ ويُلحق null في الآخر على شكل | null. والمصفوفات المختلطة تصبح (string | number)[].unknown[].export type Root = RootItem[];.مرّر النوع كمعامل generic، مثل const res = await axios.get<ChannelHistory>(url)، فينبّهك المحرر إلى أن res.data.messages[0].text قد يكون null.
للـ APIs الداخلية أو الخارجية التي ليس لها SDK أو حزمة @types، تكفي استجابة نموذجية واحدة لإنتاج ملف تعريف أنواع تشاركه مع الفريق.
ولّد interfaces من JSON وهمي في Storybook أو الاختبارات واستخدمها أنواعًا لـ props المكونات؛ وحين تنحرف البيانات الوهمية عن المكونات، يخبرك المترجم.
number (دون تمييز بين صحيح وعشري)، وسلاسل التاريخ string."status": "active"، تخرج string؛ ضيّقها بنفسك إلى اتحادات حرفية ("active" | "banned").Profile2.type بديلة بدلًا من interfaces؟لا يُستخدم الاسم البديل type إلا للمصفوفة أو القيمة البدائية على المستوى الأعلى؛ والكائنات دائمًا interfaces. إعادة كتابة export interface X { ... } بالشكل export type X = { ... }; تتصرف بالطريقة نفسها لهذا الغرض.
?) و| null منفصلين؟معناهما مختلف: ? يقول إن المفتاح قد يغيب (undefined)، بينما | null يقول إن المفتاح موجود بقيمة null. ومع تفعيل strictNullChecks تعالج الحالتين بشكل مختلف.
نوع TypeScript يصف الكائن الفعلي، والمفاتيح المعاد تسميتها لن تطابق الاستجابة بعد ذلك. إن أردت camelCase في كودك، فعرّف نوعًا منفصلًا لنتيجة دالة الربط الخاصة بك.
هذه الصفحة تُخرج تعريفات أنواع بسيطة فقط. تبويبات TypeORM وSequelize وMongoose في الأعلى تولّد كود الـ entities والنماذج من JSON نفسه.