Công cụ này đọc một giá trị JSON và viết khai báo interface TypeScript cho nó. Key được giữ đúng như cũ; mảng object được gộp thành một interface, key chỉ có ở một số phần tử nhận ?, và giá trị lẫn lộn thành union type.
Dùng nó để khai báo kiểu cho response của fetch hay axios ở frontend, khai báo kiểu trả về cho API route của Next.js hay handler Express, hoặc bất cứ khi nào backend chỉ ghi tài liệu response mẫu mà không có định nghĩa kiểu.
Tên kiểu (ví dụ ChannelHistory); nó được giữ trong URL dưới dạng ?name=.types.ts và dùng qua 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;
}
Hai tin nhắn được gộp thành một interface Message; reactions, edited và attachment chỉ có ở một trong hai nên nhận ?. text trộn chuỗi và null, cho ra string | null. Interface phần tử lấy dạng số ít của key (messages → Message).
export interface, sẵn sàng import ở nơi khác."a-b", "2fa") được đặt trong dấu nháy.?:).string | number); null được nối vào cuối thành | null. Mảng lẫn lộn thành (string | number)[].unknown[].export type Root = RootItem[];.Truyền kiểu làm generic, ví dụ const res = await axios.get<ChannelHistory>(url), và editor sẽ cảnh báo rằng res.data.messages[0].text có thể là null.
Với API nội bộ hay bên ngoài không có SDK hoặc package @types, một response mẫu là đủ để tạo file định nghĩa kiểu chia sẻ cho cả đội.
Tạo interface từ JSON giả của Storybook hay test rồi dùng làm kiểu props của component; khi dữ liệu giả lệch khỏi component, compiler sẽ báo cho bạn.
number (không tách số nguyên/số thực), và chuỗi ngày tháng là string."status": "active", ra dạng string; hãy tự thu hẹp thành literal union ("active" | "banned").Profile2.type thay vì interface không?Alias type chỉ được dùng cho mảng hoặc giá trị nguyên thủy ở cấp cao nhất; object luôn là interface. Viết lại export interface X { ... } thành export type X = { ... }; cho hành vi như nhau trong trường hợp này.
?) và | null được tách riêng?Chúng mang nghĩa khác nhau: ? nói rằng key có thể vắng mặt (undefined), còn | null nói rằng key có mặt với giá trị null. Khi bật strictNullChecks, bạn xử lý hai trường hợp này theo cách khác nhau.
Kiểu TypeScript mô tả object thực tế, nên key bị đổi tên sẽ không còn khớp với response. Nếu muốn dùng camelCase trong code, hãy định nghĩa một kiểu riêng cho kết quả của hàm mapping.
Trang này chỉ xuất khai báo kiểu thuần. Các tab TypeORM, Sequelize và Mongoose ở phía trên tạo code entity và model từ cùng một JSON.