تبدیل JSON به TypeScript

تبدیل JSON به TypeScript چیست؟

یک بار JSON را جایگذاری کنید و interface های TypeScript دریافت کنید — قراردادهای تایپ‌شده‌ای که دقیقاً مشخص می‌کنند یک شیء چه ویژگی‌هایی دارد و هر کدام چه نوعی هستند. بدون آن‌ها، داده‌ای که از JSON.parse() می‌آید به‌صورت any دریافت می‌شود و هیچ کمکی از ویرایشگر یا بررسی کامپایلر روی دسترسی به ویژگی‌ها یا انتساب آن‌ها ندارید. تبدیل JSON به TypeScript این ایمنی را بدون نوشتن دستی interface ها فراهم می‌کند.

TypeScript تمام شش نوع مقدار JSON را پوشش می‌دهد: string، number، boolean، null، object و array. هر شیء JSON تودرتو به interface جداگانه‌ای با نام مخصوص تبدیل می‌شود. آرایه‌ها بر اساس اولین عنصرشان تایپ می‌شوند. نتیجه با آنچه JSON.parse() در زمان اجرا واقعاً برمی‌گرداند مطابقت دارد، بنابراین interface ها داده واقعی را منعکس می‌کنند نه حدس و گمان.

نوشتن دستی interface ها برای JSON های بزرگ یا عمیقاً تودرتو کسل‌کننده و مستعد خطاست. یک مولد JSON به TypeScript ساختار را به‌طور خودکار می‌خواند، تودرتو بودن را بازگشتی پردازش می‌کند و کد interface تمیز را در چند ثانیه تولید می‌کند. این به‌ویژه هنگام اتصال به یک API ناآشنا، نمونه‌سازی با داده آزمایشی، یا مهاجرت یک پایگاه کد JavaScript به TypeScript مفید است. همچنین شما را از ردیابی دستی نام‌ها و نوع‌های ویژگی‌های تودرتو رها می‌کند تا بتوانید روی منطق برنامه تمرکز کنید، نه کدهای تکراری.

چرا از مولد JSON به TypeScript استفاده کنیم؟

تولید دستی interface های TypeScript برای اشیاء کوچک عملی است، اما با ساختارهای تودرتو یا پاسخ‌های بزرگ API به‌سرعت ناکارآمد می‌شود. یک پاسخ API با ۵۰ فیلد و سه سطح تودرتو را در نظر بگیرید — نوشتن دستی آن یعنی ده‌ها interface، که هر کدام منبع بالقوه‌ای برای اشتباه تایپی یا فیلدهای nullable از قلم افتاده هستند. یک مولد خودکار در چند میلی‌ثانیه مجموعه کامل را تولید می‌کند و احتمال ناهماهنگی نوع بین کد شما و داده‌ای که مصرف می‌کند را کاهش می‌دهد. فراتر از دقت، تایپ‌های شما را با قرارداد واقعی API همگام نگه می‌دارد. وقتی یک سرویس شکل پاسخ خود را تغییر می‌دهد، کافیست JSON به‌روزشده را جایگذاری کرده و دوباره تولید کنید — بسیار سریع‌تر از پیدا کردن هر ویژگی‌ای که در یک فایل interface دستی جابجا شده است.

موارد استفاده JSON به TypeScript

جدول مرجع نگاشت نوع JSON به TypeScript

هر مقدار JSON به یک نوع TypeScript نگاشت می‌شود. جدول زیر نشان می‌دهد که هر نوع اولیه و ساختاری JSON چگونه ترجمه می‌شود. این نگاشت از استاندارد JSON طبق ECMA-404 و نوع‌های توکار TypeScript پیروی می‌کند.

interface در مقابل type Alias در TypeScript

TypeScript دو روش برای توصیف شکل اشیاء ارائه می‌دهد: تعریف interface و نام مستعار type. هر دو برای نمایش ساختارهای JSON کار می‌کنند، اما در رفتار گسترش و ادغام متفاوت هستند. اکثر مولدهای JSON به TypeScript interface ها را خروجی می‌دهند زیرا انتخاب متعارف برای شکل اشیاء در TypeScript هستند.

نمونه کد

در زیر نمونه‌هایی از تولید interface های TypeScript از JSON در زبان‌ها و ابزارهای مختلف آمده است. هر قطعه خروجی قابل اجرا تولید می‌کند.

// Manual interface definition from a JSON shape
const json = '{"id": 1, "name": "Alice", "active": true}';
const parsed = JSON.parse(json);

interface User {
  id: number;
  name: string;
  active: boolean;
}

const user: User = parsed;
console.log(user.name); // "Alice" — fully typed

import JsonToTS from 'json-to-ts';

const json = {
  id: 1,
  name: "Alice",
  address: { street: "123 Main St", city: "Springfield" },
  tags: ["admin", "user"]
};

const interfaces = JsonToTS(json, { rootName: "User" });
console.log(interfaces.join("\n\n"));
// interface Address {
//   street: string;
//   city: string;
// }
//
// interface User {
//   id: number;
//   name: string;
//   address: Address;
//   tags: string[];
// }

# Install: pip install datamodel-code-generator
# Generate TypeScript-style types from JSON using Pydantic models

# Command line:
# datamodel-codegen --input data.json --output model.py

# Or generate TypeScript directly with quicktype:
# pip install quicktype
# quicktype --lang ts --src data.json --out types.ts

import json

data = {"id": 1, "name": "Alice", "scores": [98, 85, 92]}

# Python equivalent using TypedDict (Python 3.8+)
from typing import TypedDict, List

class User(TypedDict):
    id: int
    name: str
    scores: List[int]

user: User = data  # type-checked by mypy

# Install quicktype globally
npm install -g quicktype

# Generate TypeScript interfaces from a JSON file
quicktype --lang ts --src data.json --out types.ts

# From a JSON string via stdin
echo '{"id": 1, "name": "Alice"}' | quicktype --lang ts

# Output:
# export interface Root {
#   id:   number;
#   name: string;
# }

سوالات متداول