Esta ferramenta lê um valor JSON e escreve as declarações interface TypeScript correspondentes. As chaves são mantidas exatamente como estão; arrays de objetos são mesclados numa só interface, chaves presentes só em alguns itens ganham ? e valores misturados viram union types.
Use para tipar respostas de fetch ou axios no frontend, para declarar tipos de retorno de API routes do Next.js ou handlers do Express, ou sempre que um backend só documenta respostas de exemplo e nenhuma definição de tipo.
Nome do tipo (ex.: ChannelHistory); ele fica na URL como ?name=.types.ts e use 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;
}
As duas mensagens são mescladas numa única interface Message; reactions, edited e attachment só aparecem numa delas, então ganham ?. text mistura string e null, resultando em string | null. As interfaces de elemento usam a forma singular da chave (messages → Message).
export interface, pronto para importar em outro lugar."a-b", "2fa") ficam entre aspas.?:).string | number); o null é adicionado por último como | null. Arrays mistos viram (string | number)[].unknown[].export type Root = RootItem[];.Passe o tipo como generic, por exemplo const res = await axios.get<ChannelHistory>(url), e o editor avisa que res.data.messages[0].text pode ser null.
Para APIs internas ou externas sem SDK nem pacote @types, uma resposta de exemplo basta para gerar um arquivo de definição de tipos para compartilhar com o time.
Gere interfaces a partir do JSON mock do Storybook ou dos testes e use como tipo das props dos componentes; quando os mocks se desalinham dos componentes, o compilador avisa.
number (sem separação entre inteiro e float), e strings de data são string."status": "active", saem como string; restrinja-os a unions de literais ("active" | "banned") você mesmo.Profile2.type em vez de interfaces?Um alias type só é usado para um array ou primitivo no nível mais alto; objetos são sempre interface. Reescrever export interface X { ... } como export type X = { ... }; se comporta igual para esse fim.
?) e | null ficam separados?Eles significam coisas diferentes: ? diz que a chave pode estar ausente (undefined), enquanto | null diz que a chave está lá com valor null. Com strictNullChecks ligado, você trata os dois casos de formas diferentes.
Um tipo TypeScript descreve o objeto real, então chaves renomeadas deixariam de bater com a resposta. Se você quer camelCase no seu código, defina um tipo separado para o resultado da sua função de mapeamento.
Esta página só gera declarações de tipo simples. As abas TypeORM, Sequelize e Mongoose no topo geram código de entity e de model a partir do mesmo JSON.