TypeScript کے interface، type alias، enum یا class declarations پیسٹ کریں اور ان پر پورا اترنے والا مثالی JSON document حاصل کریں۔ literal unions، Record، Pick، Omit اور Partial جیسی utility types، اور extends سے جڑے interfaces سب فالو کر کے بھرے جاتے ہیں۔
اسے API بننے سے پہلے MSW یا json-server کا mock ڈیٹا تیار کرنے، Storybook props بنانے، یا بیک اینڈ ٹیم کو بالکل وہ شکل دکھانے کے لیے استعمال کریں جو آپ ان سے بھجوانا چاہتے ہیں۔
types.ts جیسی فائل سے type declarations پیسٹ کریں۔ export، import اور function declarations ساتھ ملے ہوں تو بھی ٹھیک ہے؛ صرف type declarations پڑھی جاتی ہیں۔enums شامل کریں تاکہ وہ بھرے جائیں۔ ان پٹ میں موجود نہ ہونے والے type نام null بنتے ہیں۔type UserPage = Page<User>، خود generic declaration پر ترجیح پاتا ہے۔HttpResponse.json(...)، test fixture یا Storybook args میں کاپی کریں، پھر values درست کریں۔type Channel = "email" | "sms" | "push";
enum Priority { Low = "low", High = "high" }
interface Notification {
id: string;
channel: Channel;
priority: Priority;
recipient: { userId: number; locale?: string };
payload: Record<string, string>;
readAt: Date | null;
meta: Pick<Audit, "createdBy">;
}
interface Audit { createdBy: string; createdAt: Date }{
"id": "",
"channel": "email",
"priority": "low",
"recipient": {
"userId": 0,
"locale": ""
},
"payload": {
"key": ""
},
"readAt": "1970-01-01T00:00:00.000Z",
"meta": {
"createdBy": ""
}
}Channel ایک string literal union ہے، اس لیے یہ اپنی پہلی value "email" لیتا ہے؛ string enum Priority اپنے پہلے member کی value "low" لیتا ہے۔ Record<string, string> ایک "key" والا آبجیکٹ بنتا ہے، Date | null، غیر null طرف کی ISO string بنتا ہے، اور Pick<Audit, "createdBy"> صرف چنی گئی key رکھتا ہے۔ اختیاری locale? بھی شامل ہوتا ہے۔
string → ""، number/bigint → 0، boolean → false، any/unknown → null، Date → 1970-01-01T00:00:00.000Z (Date.toJSON() والا format)۔null/undefined نہ ہو، اور intersections (A & B) اور interface ... extends properties کو ضم کرتے ہیں۔enum اپنے پہلے member کی value استعمال کرتا ہے، یا بغیر initializers والے عددی enum کے لیے 0۔Array<T> اور Set<T> کو ایک نمونہ element ملتا ہے؛ tuples کو ہر position کے لیے ایک value؛ Record<K, V>، Map اور index signatures بنتے ہیں {"key": V}۔Partial، Required، Readonly، NonNullable، Pick اور Omit سپورٹ ہیں۔static فیلڈز، get/set accessors اور @Exclude() فیلڈز خارج ہوتے ہیں۔children: TreeNode[]) خالی arrays پر کاٹ دی جاتی ہیں۔بیک اینڈ تیار ہونے سے پہلے API response types سے mock ڈیٹا بنائیں۔ UI پہلے بن سکتا ہے، اور بعد میں اصل API پر جانے سے types وہی رہتی ہیں۔
کسی کمپوننٹ کی props type سے story args یا React Testing Library کے render ڈیٹا کے لیے ڈیفالٹ آبجیکٹ بنائیں۔ ہر لازمی property موجود ہوتی ہے، اس لیے type errors کا پیچھا نہیں کرنا پڑتا۔
فرنٹ اینڈ کی request type کو JSON میں بدل کر API design doc یا issue میں پیسٹ کریں، تاکہ TypeScript استعمال نہ کرنے والے بیک اینڈ ڈویلپرز فوراً ڈھانچہ پڑھ سکیں۔
?) ہمیشہ شامل ہوتی ہیں؛ ان کی غیر موجودگی والے responses ٹیسٹ کرنے کے لیے keys خود مٹائیں۔type UserPage = Page<User> کے ساتھ items: T[] کو User سے بھرا جاتا ہے، اور argument نہ ملنے پر <T = string> جیسے defaults لاگو ہوتے ہیں۔ generics کے اندر conditional types پھر بھی evaluate نہیں ہوتیں۔T["key"] جیسی indexed access types، conditional types اور template literal types evaluate نہیں ہوتیں۔name = "kim"، retries = 3) وہی value استعمال کرتا ہے؛ new Date() جیسے دوسرے initializers صرف type کا اشارہ دیتے ہیں۔z.infer سے نکلنے والی type کو سادہ interface کی صورت میں لکھیں۔Map اور Set آبجیکٹ اور array کی صورت میں دکھائے جاتے ہیں، لیکن JSON.stringify دونوں کو {} بنا دیتا ہے، اس لیے response types میں Record یا arrays کو ترجیح دیں۔Date کا string کی صورت میں آنا درست ہے؟جی ہاں۔ JSON.stringify، Date کی جگہ اس کا toJSON() نتیجہ رکھتا ہے، جو ISO 8601 string ہے۔ وصول کرنے والی طرف کو بھی string ہی ملتی ہے، اس لیے یا تو اسے string type دیں یا parse کریں۔
status: "active" | "inactive" جیسے union کو کون سی value ملتی ہے؟declaration کی ترتیب میں پہلا literal، یعنی "active"۔ اگر آپ کوئی اور value دکھانا چاہیں تو union کی ترتیب بدل دیں۔
class declarations اور decorators parse ہوتے ہیں، اس لیے class-validator decorators والے DTOs ٹھیک تبدیل ہوتے ہیں، اور class-transformer کے @Exclude() فیلڈز چھوڑ دیے جاتے ہیں۔
الٹی سمت کے لیے JSON → TypeScript صفحہ استعمال کریں۔ الگ صفحات TypeORM، Sequelize اور Mongoose ماڈلز سے بھی JSON بناتے ہیں۔