Esta herramienta lee un valor JSON y escribe sus declaraciones interface de TypeScript. Las claves se conservan exactamente como están; los arrays de objetos se fusionan en una sola interface, las claves presentes solo en algunos elementos reciben ? y los valores mixtos pasan a union types.
Úsala para tipar respuestas de fetch o axios en el frontend, para declarar los tipos de retorno de API routes de Next.js o handlers de Express, o siempre que un backend solo documente respuestas de ejemplo y no definiciones de tipos.
Nombre del tipo (p. ej. ChannelHistory); se guarda en la URL como ?name=.types.ts y úsala mediante 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;
}
Los dos mensajes se fusionan en una sola interface Message; reactions, edited y attachment aparecen solo en uno de ellos, así que reciben ?. text mezcla una cadena y null, lo que da string | null. Las interfaces de elementos toman la forma singular de la clave (messages → Message).
export interface, listas para importar desde otros archivos."a-b", "2fa") van entre comillas.?:).string | number); null se añade al final como | null. Los arrays mixtos pasan a (string | number)[].unknown[].export type Root = RootItem[];.Pasa el tipo como genérico, p. ej. const res = await axios.get<ChannelHistory>(url), y el editor te avisa de que res.data.messages[0].text puede ser null.
Para APIs internas o externas sin SDK ni paquete @types, basta con una respuesta de ejemplo para producir un archivo de definición de tipos que compartir con el equipo.
Genera interfaces a partir del JSON mock de Storybook o de los tests y úsalas como tipos de props de los componentes; cuando los mocks se desvíen de los componentes, el compilador te lo dirá.
number (sin separar enteros y decimales), y las cadenas de fecha son string."status": "active", salen como string; restríngelos tú a uniones de literales ("active" | "banned").Profile2.type en lugar de interfaces?Solo se usa un alias type para un array o un primitivo de nivel superior; los objetos siempre son interfaces. Reescribir export interface X { ... } como export type X = { ... }; se comporta igual para este fin.
?) y | null?Significan cosas distintas: ? dice que la clave puede estar ausente (undefined), mientras que | null dice que la clave está presente con valor null. Con strictNullChecks activado, manejas los dos casos de forma diferente.
Un tipo de TypeScript describe el objeto real, así que con claves renombradas dejaría de coincidir con la respuesta. Si quieres camelCase en tu código, define un tipo aparte para el resultado de tu función de mapeo.
Esta página solo emite declaraciones de tipos simples. Las pestañas TypeORM, Sequelize y Mongoose de arriba generan código de entidades y modelos a partir del mismo JSON.