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

TypeScript interface দিন এবং উদাহরণ JSON তৈরি করুন! TypeScript interface, type সমর্থিত। API ডকুমেন্টেশন ও টেস্ট request body (sample JSON)-এর জন্য উপযোগী।
TypeScript
ফলাফল
 

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

TypeScript interface, type alias, enum বা ক্লাস ডিক্লারেশন পেস্ট করুন এবং সেগুলো পূরণ করে এমন একটি উদাহরণ JSON ডকুমেন্ট পান। Literal union, Record, Pick, Omit ও Partial-এর মতো utility type, আর extends দিয়ে যুক্ত interface সবই অনুসরণ করে পূরণ করা হয়।

API তৈরি হওয়ার আগে MSW বা json-server-এর mock ডেটা প্রস্তুত করতে, Storybook props তৈরি করতে, অথবা ব্যাকএন্ড টিমকে ঠিক কোন আকৃতিতে পাঠাতে হবে তা দেখাতে এটি ব্যবহার করুন।

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

  1. types.ts-এর মতো ফাইল থেকে type ডিক্লারেশন পেস্ট করুন। export, import আর ফাংশন ডিক্লারেশন মিশে থাকতে পারে; শুধু type ডিক্লারেশন পড়া হয়।
  2. Reference করা type আর enum-ও দিন, যাতে সেগুলো পূরণ হয়। ইনপুটে নেই এমন type-এর নাম null হয়।
  3. কোনো অপশন নেই। অন্য কোনো ডিক্লারেশন reference করে না এমন প্রথম অবজেক্ট type রুট হয়, তাই যেটি চান সেটি প্রথমে রাখুন; type UserPage = Page<User>-এর মতো generic পূরণ করা alias generic ডিক্লারেশনের চেয়ে অগ্রাধিকার পায়।
  4. ফলাফলটি MSW handler-এর HttpResponse.json(...), টেস্ট fixture বা Storybook args-এ কপি করে ভ্যালুগুলো ঠিক করুন।

উদাহরণ

ইনপুট (TypeScript)
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 }
আউটপুট (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel একটি string literal union, তাই এটি প্রথম ভ্যালু "email" নেয়; string enum Priority নেয় প্রথম member-এর ভ্যালু "low"। Record<string, string> একটিমাত্র "key"-সহ অবজেক্ট হয়, Date | null non-null দিকটি ISO স্ট্রিং হিসেবে নেয়, আর Pick<Audit, "createdBy"> শুধু বেছে নেওয়া key রাখে। ঐচ্ছিক locale?-ও অন্তর্ভুক্ত।

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

  • Primitive: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (Date.toJSON() ফরম্যাট)।
  • Literal type তার ভ্যালু ব্যবহার করে, union নেয় null/undefined নয় এমন প্রথম member, আর intersection (A & B) ও interface ... extends প্রপার্টিগুলো একত্রিত করে।
  • enum তার প্রথম member-এর ভ্যালু ব্যবহার করে, initializer ছাড়া সংখ্যার enum হলে 0।
  • Array, Array<T> আর Set<T> একটি নমুনা element পায়; tuple প্রতিটি অবস্থানে একটি ভ্যালু পায়; Record<K, V>, Map আর index signature হয় {"key": V}।
  • Partial, Required, Readonly, NonNullable, Pick আর Omit utility type সাপোর্ট করে।
  • মেথড আর ফাংশন-type প্রপার্টি JSON-এ থাকে না, তাই বাদ পড়ে; ক্লাসে static ফিল্ড, get/set accessor আর @Exclude() ফিল্ড বাদ যায়।
  • নিজেকে reference করা array (children: TreeNode[]) ফাঁকা array হিসেবে কেটে দেওয়া হয়।

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

MSW বা json-server-এর mock response

ব্যাকএন্ড প্রস্তুত হওয়ার আগে API response type থেকে mock ডেটা তৈরি করুন। UI আগে তৈরি করা যায়, আর পরে আসল API-তে গেলেও একই type থাকে।

Storybook আর টেস্টের props

কম্পোনেন্টের props type থেকে story args বা React Testing Library-র render ডেটার জন্য একটি ডিফল্ট অবজেক্ট তৈরি করুন। প্রতিটি required প্রপার্টি থাকে, তাই type error-এর পেছনে ছুটতে হয় না।

ব্যাকএন্ডের সাথে request ফরম্যাট নিয়ে একমত হওয়া

ফ্রন্টএন্ডের request type-কে JSON-এ বদলে API ডিজাইন ডকুমেন্ট বা issue-তে পেস্ট করুন, তাহলে TypeScript ব্যবহার না করা ব্যাকএন্ড ডেভেলপাররাও সাথে সাথে গঠনটি পড়তে পারেন।

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

  • ঐচ্ছিক প্রপার্টি (?) সবসময় অন্তর্ভুক্ত থাকে; সেগুলো অনুপস্থিত এমন response টেস্ট করতে key-গুলো নিজে মুছে দিন।
  • Generic parameter যেখানে type ব্যবহৃত হয় সেখানে বসানো হয়: type UserPage = Page<User> থাকলে items: T[] User দিয়ে পূরণ হয়, আর কোনো আর্গুমেন্ট না দিলে <T = string>-এর মতো default প্রযোজ্য হয়। Generic-এর ভেতরের conditional type তবুও মূল্যায়ন করা হয় না।
  • T["key"]-এর মতো indexed access type, conditional type আর template literal type মূল্যায়ন করা হয় না।
  • একটিমাত্র literal দিয়ে initialize করা ক্লাস ফিল্ড (name = "kim", retries = 3) সেই ভ্যালু ব্যবহার করে; new Date()-এর মতো অন্য initializer শুধু type-এর ইঙ্গিত দেয়।
  • Zod বা io-ts-এর মতো runtime schema কোড পড়া হয় না; z.infer যে type অনুমান করে তা সাধারণ interface হিসেবে লিখে দিন।
  • Map আর Set অবজেক্ট আর array হিসেবে দেখানো হয়, কিন্তু JSON.stringify দুটোকেই {} বানিয়ে দেয়, তাই response type-এ Record বা array ব্যবহার করাই ভালো।

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

Date স্ট্রিং হিসেবে আসা কি ঠিক?

হ্যাঁ। JSON.stringify একটি Date-কে তার toJSON() ফলাফল, অর্থাৎ ISO 8601 স্ট্রিং দিয়ে বদলে দেয়। গ্রহণকারী দিক তবুও স্ট্রিংই পায়, তাই হয় এর type string দিন, নয়তো parse করুন।

status: "active" | "inactive"-এর মতো union কোন ভ্যালু পায়?

ডিক্লারেশনের ক্রম অনুযায়ী প্রথম literal, "active"। অন্য ভ্যালু দেখাতে চাইলে union-এর ক্রম বদলান।

NestJS DTO ক্লাসের সাথে কি কাজ করে?

ক্লাস ডিক্লারেশন আর decorator parse হয়, তাই class-validator decorator দেওয়া DTO ঠিকঠাক কনভার্ট হয়, আর class-transformer-এর @Exclude() ফিল্ড বাদ পড়ে।

JSON থেকে TypeScript type-এ কীভাবে যাব?

উল্টো দিকের জন্য JSON → TypeScript পেজ ব্যবহার করুন। TypeORM, Sequelize আর Mongoose মডেল থেকে JSON তৈরির জন্যও আলাদা পেজ আছে।