Dieses Tool liest einen JSON-Wert und schreibt TypeScript-interface-Deklarationen dafür. Die Keys bleiben exakt, wie sie sind; Arrays von Objekten werden zu einem Interface zusammengeführt, Keys, die nur in manchen Elementen vorkommen, bekommen ?, und gemischte Werte werden zu Union-Typen.
Verwende es, um fetch- oder axios-Antworten im Frontend zu typisieren, um Rückgabetypen für Next.js-API-Routen oder Express-Handler zu deklarieren oder immer dann, wenn ein Backend nur Beispielantworten und keine Typdefinitionen dokumentiert.
Typname ein (z. B. ChannelHistory); er bleibt als ?name= in der URL.types.ts und verwende sie über 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;
}
Beide Nachrichten werden zu einem einzigen Interface Message zusammengeführt; reactions, edited und attachment kommen nur in einer davon vor und bekommen daher ?. text mischt einen String und null, was string | null ergibt. Element-Interfaces bekommen die Singularform des Keys (messages → Message).
export interface, bereit zum Importieren an anderer Stelle."a-b", "2fa"), werden in Anführungszeichen gesetzt.?:).string | number); null wird zuletzt als | null angehängt. Gemischte Arrays werden zu (string | number)[].unknown[].export type Root = RootItem[];.Übergib den Typ als Generic, z. B. const res = await axios.get<ChannelHistory>(url), und der Editor warnt dich, dass res.data.messages[0].text null sein kann.
Für interne oder externe APIs ohne SDK oder @types-Paket genügt eine einzige Beispielantwort, um eine Typdefinitionsdatei zu erzeugen, die du mit dem Team teilst.
Erzeuge Interfaces aus dem Mock-JSON von Storybook oder Tests und verwende sie als Props-Typen von Komponenten; laufen Mocks und Komponenten auseinander, meldet es der Compiler.
number (keine Trennung in Ganz- und Gleitkommazahlen), und Datums-Strings sind string."status": "active" kommen als string heraus; schränke sie selbst auf Literal-Unions ("active" | "banned") ein.Profile2.type-Aliase statt Interfaces bekommen?Ein type-Alias wird nur für ein Array oder einen primitiven Wert auf oberster Ebene verwendet; Objekte sind immer interfaces. export interface X { ... } als export type X = { ... }; umzuschreiben verhält sich für diesen Zweck gleich.
?) und | null getrennt gehalten?Sie bedeuten Verschiedenes: ? sagt, dass der Key fehlen darf (undefined), während | null sagt, dass der Key mit dem Wert null vorhanden ist. Mit aktiviertem strictNullChecks behandelst du die beiden Fälle unterschiedlich.
Ein TypeScript-Typ beschreibt das tatsächliche Objekt, umbenannte Keys würden also nicht mehr zur Antwort passen. Willst du in deinem Code camelCase, definiere einen eigenen Typ für das Ergebnis deiner Mapping-Funktion.
Diese Seite gibt nur reine Typdeklarationen aus. Die Tabs TypeORM, Sequelize und Mongoose oben erzeugen Entity- und Modellcode aus demselben JSON.