JSON para TypeScript
Transforme uma amostra de JSON em interfaces ou aliases de tipo de TypeScript. Objetos aninhados se tornam seus próprios tipos nomeados, arrays de objetos são combinados para que as chaves ausentes em alguns itens se tornem opcionais, e valores mistos se tornam tipos de união. Cole uma resposta de API, escolha interface ou tipo e copie declarações que você pode inserir diretamente no seu código.
Perguntas frequentes
Como objetos aninhados são tratados?
Cada objeto aninhado recebe sua própria declaração, nomeada com base na chave que o contém em PascalCase. Por exemplo, address se torna Address. Objetos dentro de arrays são nomeados com base no singular da chave do array: users se torna User e categories se torna Category. Objetos com exatamente os mesmos campos compartilham uma declaração.
Quando uma propriedade se torna opcional?
Quando um array contém vários objetos e uma chave está ausente em alguns deles, essa chave é marcada como opcional com um ponto de interrogação. As chaves presentes em todos os itens continuam obrigatórias. Um único objeto não tem outras amostras para comparação, então todas as suas chaves são obrigatórias.
Como valores null são tipados?
Uma chave com valor null na amostra é tipada como null, e uma chave com valor null em alguns itens e string em outros se torna string | null. Se um campo puder ser null nos dados reais, mas nunca for null na amostra, adicione null manualmente ou cole uma amostra que o inclua.
Devo escolher interface ou tipo?
Ambos descrevem a mesma estrutura. Interfaces podem ser estendidas e combinadas, algo que muitos guias de estilo preferem para estruturas de objetos; aliases de tipo também funcionam para uniões e são usados por algumas equipes em todo o código. Escolha o que sua base de código já usa; os campos são idênticos.
Como os arrays são tipados?
Um array com um único tipo de valor se torna esse tipo seguido de [], como string[] ou User[]. Um array com vários tipos se torna uma união entre parênteses, como (string | number)[]. Um array vazio se torna unknown[], pois a amostra não informa nada sobre seus itens.
O que acontece com chaves que não são identificadores válidos?
Chaves com espaços, hífens ou outros caracteres não permitidos em um identificador de TypeScript são escritas entre aspas, por exemplo, "first-name": string, que é válido em TypeScript e corresponde exatamente a JSON.
Os números são tipados como inteiros ou decimais?
TypeScript tem um único tipo numérico, então tanto inteiros quanto decimais se tornam number. Se precisar distinguir quais valores são números inteiros, o JSON Schema Generator diferencia integer de number.
Posso renomear o tipo raiz?
Sim. Insira um nome para o tipo raiz, como ApiResponse. Ele é convertido para PascalCase, e os tipos aninhados mantêm os nomes derivados de suas chaves. Quando o nível superior do seu JSON é um array ou um valor único, a raiz se torna um alias de tipo para ele.
As datas são detectadas?
Não. JSON não tem um tipo de data, então uma data na amostra é uma string e é tipada como string. Converta-a para Date no seu código após a análise ou restrinja o tipo manualmente se usar um tipo literal de modelo.
Qual pode ser o tamanho do JSON?
Até 1,000,000 caracteres, com aninhamento de até 64 níveis. A amostra é analisada apenas para produzir os tipos e não é armazenada.