Alat ini membaca nilai JSON dan menulis pengisytiharan interface TypeScript untuknya. Kunci dikekalkan tepat seperti asal; tatasusunan objek digabungkan menjadi satu interface, kunci yang hanya ada dalam sesetengah item mendapat ?, dan nilai bercampur menjadi union type.
Gunakannya untuk memberi jenis kepada respons fetch atau axios di frontend, mengisytiharkan jenis pulangan bagi API route Next.js atau handler Express, atau apabila backend hanya mendokumentasikan contoh respons tanpa definisi jenis.
Nama jenis (contohnya ChannelHistory); ia disimpan dalam URL sebagai ?name=.types.ts dan gunakannya melalui 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;
}
Kedua-dua mesej digabungkan menjadi satu interface Message; reactions, edited dan attachment hanya muncul dalam salah satu daripadanya, jadi ia mendapat ?. text bercampur antara rentetan dan null, menghasilkan string | null. Interface elemen mengambil bentuk tunggal kunci (messages → Message).
export interface, sedia untuk diimport di tempat lain."a-b", "2fa") diletakkan dalam petikan.?:).string | number); null ditambah paling akhir sebagai | null. Tatasusunan bercampur menjadi (string | number)[].unknown[].export type Root = RootItem[];.Hantar jenis sebagai generic, contohnya const res = await axios.get<ChannelHistory>(url), dan editor akan memberi amaran bahawa res.data.messages[0].text mungkin null.
Bagi API dalaman atau luaran tanpa SDK atau pakej @types, satu sampel respons sudah cukup untuk menghasilkan fail definisi jenis untuk dikongsi dengan pasukan.
Jana interface daripada JSON mock Storybook atau ujian dan gunakannya sebagai jenis props komponen; apabila mock tidak lagi selari dengan komponen, compiler akan memberitahu anda.
number (tiada pemisahan integer/float), dan rentetan tarikh ialah string."status": "active", dijana sebagai string; sempitkan sendiri kepada literal union ("active" | "banned").Profile2.type dan bukan interface?Alias type hanya digunakan untuk tatasusunan atau primitif peringkat atas; objek sentiasa interface. Menulis semula export interface X { ... } sebagai export type X = { ... }; berkelakuan sama untuk tujuan ini.
?) dan | null diasingkan?Maksudnya berbeza: ? bermaksud kunci mungkin tiada (undefined), manakala | null bermaksud kunci itu ada dengan nilai null. Dengan strictNullChecks dihidupkan, anda mengendalikan kedua-dua kes secara berbeza.
Jenis TypeScript menerangkan objek sebenar, jadi kunci yang dinamakan semula tidak lagi sepadan dengan respons. Jika anda mahukan camelCase dalam kod, takrifkan jenis berasingan untuk hasil fungsi pemetaan anda.
Halaman ini hanya menjana pengisytiharan jenis biasa. Tab TypeORM, Sequelize dan Mongoose di bahagian atas menjana kod entity dan model daripada JSON yang sama.