JSON sang TypeScript

Ví dụ

Đầu vào:

{ "id": 1, "name": "Alice", "age": null, "tags": ["admin", "user"], "address": { "city": "Madrid" } }

Đầu ra:

interface User {
  id: number;
  name: string;
  age: number | null;
  tags: string[];
  address: Address;
}

interface Address {
  city: string;
}

Ánh xạ kiểu

Trường tùy chọn so với trường cho phép null

• foo?: string, trường này có thể vắng mặt khỏi đối tượng. Cần kiểm tra undefined.
• foo: string | null, trường này luôn hiện diện nhưng có thể được đặt null một cách tường minh.
• foo?: string | null, có thể vắng mặt HOẶC là null.

Bản thân JSON không có undefined, nhưng các API báo hiệu sự vắng mặt của trường theo những cách khác nhau. Hãy khớp với ngữ nghĩa của API bạn dùng.

• Các API REST thường bỏ qua trường bị thiếu -> ?:.
• GraphQL luôn trả về mọi trường được yêu cầu -> | null.
• Một số SDK dùng cả hai cách trong các ngữ cảnh khác nhau.

Kiểu hợp so với kiểu literal

Nếu công cụ thấy cùng một trường chuỗi chỉ nhận một tập nhỏ giá trị qua các mẫu ("status": "pending", "active", "archived"), nó có thể tạo ra một kiểu hợp của các literal chuỗi:

status: "pending" | "active" | "archived";

Bật “suy luận kiểu hợp của literal chuỗi” nếu bạn muốn điều này.

Lỗi thường gặp

• Suy luận từ một mẫu duy nhất. Mọi trường đều trở thành bắt buộc; không thể quan sát khả năng null. Để có kiểu tốt hơn, hãy cung cấp 5-10 mẫu đa dạng.
• Mảng rỗng. "tags": [] không cung cấp thông tin kiểu, trình tạo sẽ xuất ra unknown[]. Hãy cung cấp một mẫu có ít nhất một phần tử.
• Mảng kiểu hỗn hợp. [1, "two", true] tạo ra (number | string | boolean)[]. Thường thì điều này có nghĩa là JSON nên được thiết kế lại thay vì định kiểu như hiện tại.
• Khóa dạng chuỗi số. JSON {"1": "a", "2": "b"} vẫn là một đối tượng trong TypeScript (Record<string, string>), không phải mảng. Trình tạo xử lý đúng trường hợp này.