এই টুল একটি JSON ভ্যালু পড়ে তার জন্য TypeScript interface ডিক্লারেশন লেখে। Key-গুলো হুবহু রাখা হয়; অবজেক্টের array একটি interface-এ একত্রিত হয়, শুধু কিছু আইটেমে থাকা key ? পায়, আর মিশ্র ভ্যালু union type হয়।
ফ্রন্টএন্ডে fetch বা axios response-এর type দিতে, Next.js API route বা Express handler-এর return type ডিক্লেয়ার করতে, অথবা যখনই কোনো ব্যাকএন্ড শুধু উদাহরণ response ডকুমেন্ট করে কিন্তু type ডেফিনিশন দেয় না, তখন এটি ব্যবহার করুন।
টাইপের নাম-এ রুট interface-এর নাম দিন (যেমন ChannelHistory); এটি URL-এ ?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;
}
দুটি মেসেজ একটি Message interface-এ একত্রিত হয়েছে; reactions, edited আর attachment শুধু একটিতে আছে, তাই সেগুলো ? পায়। text-এ স্ট্রিং আর null মেশানো, ফলে হয় string | null। Element interface key-এর একবচন রূপ নেয় (messages → Message)।
export interface, অন্য জায়গায় import করার জন্য প্রস্তুত।"a-b", "2fa") কোটে রাখা হয়।?:) হয়।string | number); null সবার শেষে | null হিসেবে যোগ হয়। মিশ্র array হয় (string | number)[]।unknown[] হয়।export type Root = RootItem[];-এর মতো একটি alias-ও তৈরি হয়।Type-টি generic হিসেবে দিন, যেমন const res = await axios.get<ChannelHistory>(url), তাহলে এডিটর সতর্ক করবে যে res.data.messages[0].text null হতে পারে।
যেসব ইন্টারনাল বা এক্সটার্নাল API-এর কোনো SDK বা @types প্যাকেজ নেই, সেগুলোর জন্য একটি নমুনা response-ই টিমের সাথে শেয়ার করার মতো type ডেফিনিশন ফাইল তৈরি করতে যথেষ্ট।
Storybook বা টেস্টের mock JSON থেকে interface তৈরি করে কম্পোনেন্টের props type হিসেবে ব্যবহার করুন; mock আর কম্পোনেন্ট আলাদা হয়ে গেলে কম্পাইলার জানিয়ে দেবে।
number (integer/float আলাদা করা হয় না), আর তারিখের স্ট্রিং string।"status": "active"-এর মতো নির্দিষ্ট কিছু ভ্যালুর ফিল্ড string হিসেবে আসে; সেগুলো নিজে literal union-এ ("active" | "banned") সংকুচিত করুন।Profile2-এর মতো সংখ্যার suffix যোগ হয়।type alias পাওয়া যায়?type alias শুধু top-level array বা primitive-এর জন্য ব্যবহৃত হয়; অবজেক্ট সবসময় interface। এই কাজের জন্য export interface X { ... }-কে export type X = { ... }; হিসেবে লিখলেও একই আচরণ করে।
?) আর | null কেন আলাদা রাখা হয়?দুটোর অর্থ আলাদা: ? বলে key-টি অনুপস্থিত (undefined) থাকতে পারে, আর | null বলে key-টি আছে কিন্তু ভ্যালু null। strictNullChecks চালু থাকলে দুটি ক্ষেত্র ভিন্নভাবে হ্যান্ডেল করতে হয়।
TypeScript type আসল অবজেক্টকে বর্ণনা করে, তাই key-এর নাম বদলালে তা আর response-এর সাথে মিলবে না। কোডে camelCase চাইলে আপনার ম্যাপিং ফাংশনের ফলাফলের জন্য আলাদা একটি type ডিফাইন করুন।
এই পেজ শুধু সাধারণ type ডিক্লারেশন তৈরি করে। উপরের TypeORM, Sequelize আর Mongoose ট্যাবগুলো একই JSON থেকে entity আর মডেল কোড তৈরি করে।