איך הכלי מסיק אילו שדות להגדיר
הממיר בודק כל פריט במערך. בדוגמה הזו, השדה active מופיע רק ברשומה הראשונה ולכן הוא אופציונלי. השדה name מופיע בשתי הרשומות, עם מחרוזת באחת ועם null בשנייה. לכן זהו שדה חובה והטיפוס שלו הוא string | null.
[
{ "id": 1, "name": "Ada", "active": true },
{ "id": 2, "name": null }
]
export type ApiResponse = Array<{
id: number
name: string | null
active?: boolean
}>
אם המערך בדוגמה ריק, טיפוס האיברים שלו יהיה unknown. כדי לקבל תוצאה שמייצגת טוב יותר את תגובות ה-API שלכם, כללו רשומות שמדגימות את המבנים השונים שהוא מחזיר.
מתי להשתמש ב-TypeScript ומתי ב-Zod
השתמשו ב-TypeScript לבדיקות בעורך הקוד ובזמן ההידור. השתמשו ב-Zod כדי לאמת נתונים נכנסים בזמן הריצה באמצעות apiResponseSchema.safeParse(data). קובץ ה-Zod שנוצר מייצא גם את טיפוס ה-TypeScript. הוסיפו כללים ייחודיים ל-API, כגון ערכים מותרים או פורמטים של מחרוזות, בהתאם לחוזה של ה-API שלכם.