JSON কে TypeScript টাইপে রূপান্তর করুন!

JSON দিন এবং সেটিকে TypeScript interface-এ রূপান্তর করুন! TypeScript interface সমর্থিত। TypeORM · Sequelize · Mongoose উপরের ট্যাবে।
JSON
ফলাফল
 

JSON কে TypeScript টাইপে রূপান্তর করুন!

এই টুল একটি JSON ভ্যালু পড়ে তার জন্য TypeScript interface ডিক্লারেশন লেখে। Key-গুলো হুবহু রাখা হয়; অবজেক্টের array একটি interface-এ একত্রিত হয়, শুধু কিছু আইটেমে থাকা key ? পায়, আর মিশ্র ভ্যালু union type হয়।

ফ্রন্টএন্ডে fetch বা axios response-এর type দিতে, Next.js API route বা Express handler-এর return type ডিক্লেয়ার করতে, অথবা যখনই কোনো ব্যাকএন্ড শুধু উদাহরণ response ডকুমেন্ট করে কিন্তু type ডেফিনিশন দেয় না, তখন এটি ব্যবহার করুন।

কীভাবে ব্যবহার করবেন

  1. একটি response JSON পেস্ট করুন, যেমন DevTools-এর Network ট্যাব থেকে কপি করা।
  2. টাইপের নাম-এ রুট 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;
}

দুটি মেসেজ একটি Message interface-এ একত্রিত হয়েছে; reactions, edited আর attachment শুধু একটিতে আছে, তাই সেগুলো ? পায়। text-এ স্ট্রিং আর null মেশানো, ফলে হয় string | null। Element interface key-এর একবচন রূপ নেয় (messages → Message)।

সমর্থিত বৈশিষ্ট্য

  • প্রতিটি ডিক্লারেশন একটি export interface, অন্য জায়গায় import করার জন্য প্রস্তুত।
  • JSON key-এর নাম বদলানো হয় না, তাই type-গুলো response অবজেক্টের সাথে এক-এক মেলে; বৈধ identifier নয় এমন key ("a-b", "2fa") কোটে রাখা হয়।
  • অবজেক্টের array প্রতিটি element-এর key একত্রিত করে; কিছু element-এ না থাকা key ঐচ্ছিক (?:) হয়।
  • মিশ্র type থেকে union তৈরি হয় (string | number); null সবার শেষে | null হিসেবে যোগ হয়। মিশ্র array হয় (string | number)[]।
  • ফাঁকা array থেকে অনুমান করার মতো element type নেই, তাই সেটি unknown[] হয়।
  • Top-level array থেকে export type Root = RootItem[];-এর মতো একটি alias-ও তৈরি হয়।

ব্যবহারের ক্ষেত্র

fetch আর axios response-এর type দেওয়া

Type-টি generic হিসেবে দিন, যেমন const res = await axios.get<ChannelHistory>(url), তাহলে এডিটর সতর্ক করবে যে res.data.messages[0].text null হতে পারে।

Typing ছাড়া থার্ড-পার্টি API

যেসব ইন্টারনাল বা এক্সটার্নাল API-এর কোনো SDK বা @types প্যাকেজ নেই, সেগুলোর জন্য একটি নমুনা response-ই টিমের সাথে শেয়ার করার মতো type ডেফিনিশন ফাইল তৈরি করতে যথেষ্ট।

Mock ডেটা আর কম্পোনেন্ট props

Storybook বা টেস্টের mock JSON থেকে interface তৈরি করে কম্পোনেন্টের props type হিসেবে ব্যবহার করুন; mock আর কম্পোনেন্ট আলাদা হয়ে গেলে কম্পাইলার জানিয়ে দেবে।

নোট ও সীমাবদ্ধতা

  • Interface কম্পাইলের সময় মুছে যায় এবং runtime-এ যাচাই করে না যে response-এর আকৃতি সত্যিই এমন। Runtime validation দরকার হলে zod-এর মতো schema লাইব্রেরির সাথে ব্যবহার করুন।
  • সব সংখ্যা number (integer/float আলাদা করা হয় না), আর তারিখের স্ট্রিং string।
  • "status": "active"-এর মতো নির্দিষ্ট কিছু ভ্যালুর ফিল্ড string হিসেবে আসে; সেগুলো নিজে literal union-এ ("active" | "banned") সংকুচিত করুন।
  • ভিন্ন key-এর অধীনে একই আকৃতি থাকলে প্রত্যেকটি নিজস্ব interface পায়, আর নামের সংঘাত হলে Profile2-এর মতো সংখ্যার suffix যোগ হয়।

সাধারণ প্রশ্ন

Interface-এর বদলে কি type alias পাওয়া যায়?

type alias শুধু top-level array বা primitive-এর জন্য ব্যবহৃত হয়; অবজেক্ট সবসময় interface। এই কাজের জন্য export interface X { ... }-কে export type X = { ... }; হিসেবে লিখলেও একই আচরণ করে।

ঐচ্ছিক (?) আর | null কেন আলাদা রাখা হয়?

দুটোর অর্থ আলাদা: ? বলে key-টি অনুপস্থিত (undefined) থাকতে পারে, আর | null বলে key-টি আছে কিন্তু ভ্যালু null। strictNullChecks চালু থাকলে দুটি ক্ষেত্র ভিন্নভাবে হ্যান্ডেল করতে হয়।

Key-গুলো কেন camelCase-এ কনভার্ট হয় না?

TypeScript type আসল অবজেক্টকে বর্ণনা করে, তাই key-এর নাম বদলালে তা আর response-এর সাথে মিলবে না। কোডে camelCase চাইলে আপনার ম্যাপিং ফাংশনের ফলাফলের জন্য আলাদা একটি type ডিফাইন করুন।

আমার ORM entity (TypeORM, Sequelize, Mongoose) দরকার।

এই পেজ শুধু সাধারণ type ডিক্লারেশন তৈরি করে। উপরের TypeORM, Sequelize আর Mongoose ট্যাবগুলো একই JSON থেকে entity আর মডেল কোড তৈরি করে।