Tool ini membaca nilai JSON dan menuliskan deklarasi interface TypeScript untuknya. Key dipertahankan persis seperti aslinya; array objek digabung menjadi satu interface, key yang hanya ada di sebagian item mendapat ?, dan nilai campuran menjadi union type.
Gunakan untuk memberi tipe pada respons fetch atau axios di frontend, mendeklarasikan return type untuk API route Next.js atau handler Express, atau kapan pun backend hanya mendokumentasikan contoh respons tanpa definisi tipe.
Nama tipe (misalnya ChannelHistory); nama ini disimpan di URL sebagai ?name=.types.ts dan gunakan lewat 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 pesan digabung menjadi satu interface Message; reactions, edited dan attachment hanya muncul di salah satunya, jadi mendapat ?. text mencampur string dan null, menghasilkan string | null. Interface elemen memakai bentuk tunggal dari key-nya (messages → Message).
export interface, siap di-import di tempat lain."a-b", "2fa") diberi tanda kutip.?:).string | number); null ditambahkan paling akhir sebagai | null. Array campuran menjadi (string | number)[].unknown[].export type Root = RootItem[];.Berikan tipenya sebagai generic, misalnya const res = await axios.get<ChannelHistory>(url), dan editor memperingatkan Anda bahwa res.data.messages[0].text bisa bernilai null.
Untuk API internal maupun eksternal yang tidak punya SDK atau package @types, satu contoh respons sudah cukup untuk membuat file definisi tipe yang bisa dibagikan ke tim.
Buat interface dari JSON mock Storybook atau test dan gunakan sebagai tipe props komponen; ketika mock dan komponen tidak lagi sejalan, compiler memberi tahu Anda.
number (tidak ada pemisahan integer/float), dan string tanggal bertipe string."status": "active", keluar sebagai string; persempit sendiri menjadi union literal ("active" | "banned").Profile2.type alih-alih interface?Alias type hanya dipakai untuk array atau primitive tingkat atas; objek selalu berupa interface. Menulis ulang export interface X { ... } menjadi export type X = { ... }; berperilaku sama untuk keperluan ini.
?) dan | null dipisahkan?Artinya berbeda: ? berarti key-nya mungkin tidak ada (undefined), sedangkan | null berarti key-nya ada dengan nilai null. Dengan strictNullChecks aktif, Anda menangani kedua kasus itu secara berbeda.
Tipe TypeScript mendeskripsikan objek yang sebenarnya, jadi key yang diganti namanya tidak akan lagi cocok dengan respons. Jika Anda ingin camelCase di kode, definisikan tipe terpisah untuk hasil fungsi mapping Anda.
Halaman ini hanya mengeluarkan deklarasi tipe biasa. Tab TypeORM, Sequelize, dan Mongoose di bagian atas membuat kode entity dan model dari JSON yang sama.