JSON کو TypeScript ٹائپس میں تبدیل کریں!

JSON درج کریں اور اسے TypeScript interface میں تبدیل کریں! TypeScript interface سپورٹ۔ TypeORM · Sequelize · Mongoose اوپر والے ٹیبز میں۔
JSON
نتیجہ
 

JSON کو TypeScript ٹائپس میں تبدیل کریں!

یہ ٹول JSON value پڑھ کر اس کے لیے TypeScript interface declarations لکھتا ہے۔ keys بالکل جیسی ہیں ویسی رہتی ہیں؛ objects کی arrays ایک interface میں ضم ہو جاتی ہیں، صرف کچھ items میں موجود keys کو ? ملتا ہے، اور ملی جلی values union types بنتی ہیں۔

اسے فرنٹ اینڈ پر fetch یا axios responses کو type کرنے، Next.js API routes یا Express handlers کی return types ڈکلیئر کرنے کے لیے استعمال کریں، یا جب بھی کوئی بیک اینڈ صرف مثالی responses کی documentation دے اور type definitions نہ دے۔

استعمال کا طریقہ

  1. response JSON پیسٹ کریں، مثلاً DevTools کے Network ٹیب سے کاپی کیا گیا۔
  2. ٹائپ کا نام میں root interface کا نام لکھیں (مثلاً ChannelHistory)؛ یہ URL میں ?name= کے طور پر محفوظ رہتا ہے۔
  3. آؤٹ پٹ کو types.ts جیسی فائل میں محفوظ کریں اور import type { ChannelHistory } from "./types" کے ذریعے استعمال کریں۔

مثال

ان پٹ (JSON)
{
  "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
}
آؤٹ پٹ (TypeScript)
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;
}

دونوں messages ایک ہی Message interface میں ضم ہو جاتے ہیں؛ reactions، edited اور attachment ان میں سے صرف ایک میں ہیں، اس لیے انہیں ? ملتا ہے۔ text میں string اور null ملے جلے ہیں، جس سے string | null بنتا ہے۔ element interfaces، key کی واحد شکل کا نام لیتے ہیں (messages → Message)۔

معاون خصوصیات

  • ہر declaration ایک export interface ہے، کہیں بھی import کرنے کے لیے تیار۔
  • JSON keys کے نام نہیں بدلے جاتے، اس لیے types، response آبجیکٹ سے ایک ایک کر کے میل کھاتی ہیں؛ جو keys درست identifiers نہیں ("a-b"، "2fa") انہیں quotes میں رکھا جاتا ہے۔
  • objects کی arrays ہر element کی keys کو ضم کرتی ہیں؛ کچھ elements میں غائب keys اختیاری (?:) بن جاتی ہیں۔
  • ملی جلی types سے unions بنتے ہیں (string | number)؛ null سب سے آخر میں | null کی صورت میں جوڑا جاتا ہے۔ ملی جلی arrays بنتی ہیں (string | number)[]۔
  • خالی arrays میں اندازہ لگانے کو کوئی element type نہیں، اس لیے وہ unknown[] بنتی ہیں۔
  • سب سے اوپر کی array کے لیے export type Root = RootItem[]; جیسا alias بھی بنتا ہے۔

استعمال کے کیس

fetch اور axios responses کو type کرنا

type کو generic کے طور پر دیں، مثلاً const res = await axios.get<ChannelHistory>(url)، اور ایڈیٹر آپ کو خبردار کرتا ہے کہ res.data.messages[0].text، null ہو سکتا ہے۔

typings کے بغیر third-party APIs

جن اندرونی یا بیرونی APIs کا کوئی SDK یا @types package نہیں، ان کے لیے ایک نمونہ response ہی ٹیم کے ساتھ شیئر کرنے والی type definition فائل بنانے کو کافی ہے۔

mock ڈیٹا اور کمپوننٹ props

Storybook یا test mock JSON سے interfaces بنا کر انہیں کمپوننٹ props types کے طور پر استعمال کریں؛ جب mocks کمپوننٹس سے ہٹ جائیں تو compiler آپ کو بتا دیتا ہے۔

نوٹس اور حدود

  • interfaces compile کے وقت مٹ جاتے ہیں اور runtime پر چیک نہیں کرتے کہ response واقعی اسی شکل کا ہے۔ اگر runtime validation چاہیے تو انہیں zod جیسی schema لائبریری کے ساتھ استعمال کریں۔
  • تمام نمبر number ہوتے ہیں (integer/float کی تقسیم نہیں)، اور تاریخ والی strings string ہوتی ہیں۔
  • "status": "active" جیسے مقررہ values والے فیلڈز string کی صورت میں آتے ہیں؛ انہیں literal unions ("active" | "banned") تک خود محدود کریں۔
  • مختلف keys کے نیچے ایک جیسی شکلوں کو الگ الگ interface ملتا ہے، اور ٹکرانے والے ناموں کے آخر میں Profile2 جیسا عددی لاحقہ لگتا ہے۔

عام سوالات

کیا مجھے interfaces کے بجائے type aliases مل سکتے ہیں؟

type alias صرف سب سے اوپر کی array یا primitive کے لیے استعمال ہوتا ہے؛ objects ہمیشہ interface ہوتے ہیں۔ اس مقصد کے لیے export interface X { ... } کو export type X = { ... }; کی طرح دوبارہ لکھنا ویسا ہی کام کرتا ہے۔

اختیاری (?) اور | null الگ الگ کیوں رکھے گئے ہیں؟

ان کے معنی مختلف ہیں: ? کہتا ہے کہ key غائب ہو سکتی ہے (undefined)، جبکہ | null کہتا ہے کہ key موجود ہے اور اس کی value null ہے۔ strictNullChecks آن ہونے پر آپ دونوں صورتوں کو الگ طریقے سے سنبھالتے ہیں۔

keys کو camelCase میں کیوں نہیں بدلا جاتا؟

TypeScript type اصل آبجیکٹ کو بیان کرتی ہے، اس لیے نام بدلی ہوئی keys response سے میل نہیں کھائیں گی۔ اگر آپ کو اپنے کوڈ میں camelCase چاہیے تو اپنی mapping function کے نتیجے کے لیے الگ type بیان کریں۔

مجھے ORM entities (TypeORM، Sequelize، Mongoose) چاہئیں۔

یہ صفحہ صرف سادہ type declarations دیتا ہے۔ اوپر کے TypeORM، Sequelize اور Mongoose ٹیبز اسی JSON سے entity اور ماڈل کوڈ بناتے ہیں۔