Cet outil lit une valeur JSON et écrit les déclarations interface TypeScript correspondantes. Les clés sont conservées telles quelles ; les tableaux d'objets sont fusionnés en une seule interface, les clés présentes dans seulement certains éléments reçoivent ?, et les valeurs mixtes deviennent des types union.
Utilisez-le pour typer les réponses fetch ou axios côté frontend, déclarer les types de retour des API routes Next.js ou des handlers Express, ou chaque fois qu'un backend ne documente que des exemples de réponses, sans définitions de types.
Nom du type (par exemple ChannelHistory) ; il est conservé dans l'URL sous la forme ?name=.types.ts et utilisez-la via 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;
}
Les deux messages sont fusionnés en une seule interface Message ; reactions, edited et attachment n'apparaissent que dans l'un d'eux et reçoivent donc ?. text mélange une chaîne et null, ce qui donne string | null. Les interfaces d'éléments prennent la forme au singulier de la clé (messages → Message).
export interface, prête à être importée ailleurs."a-b", "2fa") sont mises entre guillemets.?:).string | number) ; null est ajouté en dernier sous la forme | null. Les tableaux mixtes deviennent (string | number)[].unknown[].export type Root = RootItem[];.Passez le type en générique, par exemple const res = await axios.get<ChannelHistory>(url), et l'éditeur vous prévient que res.data.messages[0].text peut valoir null.
Pour des API internes ou externes sans SDK ni package @types, une seule réponse d'exemple suffit à produire un fichier de définitions de types à partager avec l'équipe.
Générez des interfaces à partir du JSON fictif de Storybook ou des tests et utilisez-les comme types de props ; quand les mocks s'écartent des composants, le compilateur vous le signale.
number (pas de distinction entier/flottant), et les chaînes de date sont string."status": "active", sortent en string ; restreignez-les vous-même en unions de littéraux ("active" | "banned").Profile2.type au lieu d'interfaces ?Un alias type n'est utilisé que pour un tableau ou une valeur primitive de premier niveau ; les objets sont toujours des interface. Réécrire export interface X { ... } en export type X = { ... }; se comporte de la même façon pour cet usage.
?) et | null sont-ils distincts ?Ils ne veulent pas dire la même chose : ? indique que la clé peut être absente (undefined), tandis que | null indique que la clé est présente avec une valeur null. Avec strictNullChecks activé, vous traitez les deux cas différemment.
Un type TypeScript décrit l'objet réel : des clés renommées ne correspondraient plus à la réponse. Si vous voulez du camelCase dans votre code, définissez un type séparé pour le résultat de votre fonction de mapping.
Cette page n'émet que de simples déclarations de types. Les onglets TypeORM, Sequelize et Mongoose en haut génèrent du code d'entité et de modèle à partir du même JSON.