Tampal pengisytiharan interface, alias type, enum atau kelas TypeScript dan dapatkan contoh dokumen JSON yang mematuhinya. Literal union, Record, utility type seperti Pick, Omit dan Partial, serta interface yang dirantai dengan extends semuanya diikuti dan diisi.
Gunakannya sebelum API wujud untuk menyediakan data mock MSW atau json-server, mencipta props Storybook, atau menunjukkan kepada pasukan backend bentuk tepat yang anda mahu mereka hantar.
types.ts. export, import dan pengisytiharan fungsi boleh bercampur; hanya pengisytiharan jenis yang dibaca.enum yang dirujuk supaya ia diisi. Nama jenis yang tiada dalam input menjadi null.type UserPage = Page<User>, diutamakan berbanding pengisytiharan generic itu sendiri.HttpResponse.json(...) handler MSW, fixture ujian atau args Storybook, kemudian laraskan nilainya.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 }{
"id": "",
"channel": "email",
"priority": "low",
"recipient": {
"userId": 0,
"locale": ""
},
"payload": {
"key": ""
},
"readAt": "1970-01-01T00:00:00.000Z",
"meta": {
"createdBy": ""
}
}Channel ialah string literal union, jadi ia mengambil nilai pertamanya "email"; enum rentetan Priority mengambil nilai ahli pertamanya "low". Record<string, string> menjadi objek dengan satu "key", Date | null dileraikan kepada sisi bukan null sebagai rentetan ISO, dan Pick<Audit, "createdBy"> hanya mengekalkan kunci yang dipilih. locale? yang opsional turut disertakan.
string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (format Date.toJSON()).null/undefined, dan intersection (A & B) serta interface ... extends menggabungkan property.enum menggunakan nilai ahli pertamanya, atau 0 bagi enum numerik tanpa initializer.Array<T> dan Set<T> mendapat satu elemen contoh; tuple mendapat satu nilai bagi setiap kedudukan; Record<K, V>, Map dan index signature menjadi {"key": V}.Partial, Required, Readonly, NonNullable, Pick dan Omit.static, accessor get/set dan medan @Exclude() dikecualikan.children: TreeNode[]) dipotong sebagai array kosong.Sebelum backend siap, jana data mock daripada jenis respons API. UI boleh dibina dahulu, dan apabila beralih ke API sebenar kemudian, jenisnya kekal sama.
Cipta objek lalai daripada jenis props komponen untuk args story atau data render React Testing Library. Setiap property wajib ada, jadi tiada ralat jenis yang perlu dikejar.
Tukar jenis request frontend kepada JSON dan tampal ke dalam dokumen reka bentuk API atau issue, supaya pembangun backend yang tidak menggunakan TypeScript dapat membaca strukturnya serta-merta.
?) sentiasa disertakan; padam sendiri kunci tersebut untuk menguji respons apabila ia tiada.type UserPage = Page<User>, items: T[] diisi dengan User, dan default seperti <T = string> digunakan apabila tiada argumen diberikan. Conditional type di dalam generic masih tidak dinilai.T["key"], conditional type dan template literal type tidak dinilai.name = "kim", retries = 3) menggunakan nilai itu; initializer lain seperti new Date() hanya memberi petunjuk tentang jenis.z.infer sebagai interface biasa.Map dan Set dipaparkan sebagai objek dan array, tetapi JSON.stringify menukar kedua-duanya kepada {}, jadi lebih baik gunakan Record atau array dalam jenis respons.Date keluar sebagai rentetan?Ya. JSON.stringify menggantikan Date dengan hasil toJSON()nya, iaitu rentetan ISO 8601. Pihak penerima tetap menerima rentetan, jadi sama ada berikan jenis string atau huraikannya.
status: "active" | "inactive"?Literal pertama mengikut susunan pengisytiharan, "active". Susun semula union jika anda mahu memaparkan nilai lain.
Pengisytiharan kelas dan decorator dihuraikan, jadi DTO yang dianotasi dengan decorator class-validator boleh ditukar dengan baik, dan medan @Exclude() class-transformer ditinggalkan.
Gunakan halaman JSON → TypeScript untuk arah sebaliknya. Halaman berasingan juga menjana JSON daripada model TypeORM, Sequelize dan Mongoose.