Saltar al contenido

De JSON a TypeScript

Convierte un ejemplo de JSON en interfaces o alias de tipo de TypeScript. Los objetos anidados se convierten en tipos con nombre propio, los arrays de objetos se combinan para que las claves que faltan en algunos elementos sean opcionales y los valores mixtos se convierten en tipos de unión. Pega una respuesta de API, elige interface o type y copia declaraciones listas para usar directamente en tu código.

Restablecer

Preguntas frecuentes

¿Cómo se gestionan los objetos anidados?

Cada objeto anidado tiene su propia declaración, con un nombre derivado de la clave que lo contiene en PascalCase; por ejemplo, address se convierte en Address. Los objetos dentro de arrays reciben el nombre del singular de la clave del array, así que users se convierte en User y categories en Category. Los objetos con exactamente los mismos campos comparten una declaración.

¿Cuándo pasa una propiedad a ser opcional?

Cuando un array contiene varios objetos y a algunos les falta una clave, esta se marca como opcional con un signo de interrogación. Las claves presentes en todos los elementos siguen siendo obligatorias. Un objeto único no tiene otras muestras con las que compararse, así que todas sus claves son obligatorias.

¿Cómo se tipan los valores null?

Una clave cuyo valor es null en tu ejemplo se tipa como null; si en algunos elementos vale null y en otros es una cadena, se convierte en string | null. Si un campo puede ser null en los datos reales, pero nunca lo es en tu ejemplo, añade null manualmente o pega un ejemplo que lo incluya.

¿Debo elegir interface o type?

Ambos describen la misma estructura. Las interfaces se pueden ampliar y combinar, algo que muchas guías de estilo prefieren para las estructuras de objetos; los alias de tipo también sirven para uniones y algunos equipos los usan en todas partes. Elige lo que use tu base de código; los campos son idénticos.

¿Cómo se tipan los arrays?

Un array con un solo tipo de valor se convierte en ese tipo seguido de [], como string[] o User[]. Un array con varios tipos se convierte en una unión entre paréntesis, como (string | number)[]. Un array vacío se convierte en unknown[], porque el ejemplo no aporta información sobre sus elementos.

¿Qué ocurre con las claves que no son identificadores válidos?

Las claves con espacios, guiones u otros caracteres no permitidos en un identificador de TypeScript se escriben entre comillas; por ejemplo, "first-name": string, que es válido en TypeScript y coincide exactamente con JSON.

¿Los números se tipan como enteros o decimales?

TypeScript tiene un solo tipo numérico, así que tanto los enteros como los decimales se convierten en number. Si necesitas distinguir los valores enteros, el generador de esquemas de JSON distingue integer de number.

¿Puedo cambiar el nombre del tipo raíz?

Sí. Escribe un nombre para el tipo raíz, como ApiResponse. Se convierte a PascalCase y los tipos anidados conservan los nombres derivados de sus claves. Si el nivel superior de tu JSON es un array o un valor único, la raíz se convierte en un alias de tipo para ese valor.

¿Se detectan las fechas?

No. JSON no tiene un tipo de fecha, así que una fecha en tu ejemplo es una cadena y se tipa como string. Conviértela a Date en tu código después de analizarla o restringe el tipo manualmente si usas un tipo literal de plantilla.

¿Cuál es el tamaño máximo de JSON?

Hasta 1,000,000 caracteres y 64 niveles de anidamiento. El ejemplo solo se analiza para generar los tipos y no se almacena.

Acerca de OneClick Pro

OneClick Pro es una colección gratuita de más de 150 herramientas web para las tareas cotidianas: convertir imágenes y unidades, dar formato y validar código, consultar dominios y SEO, y trabajar con texto, fechas y números. Todas las herramientas funcionan sin registro ni suscripción; los datos que introduce solo se utilizan para calcular el resultado y nunca se almacenan. Úsela como una caja de herramientas para tareas puntuales o añada a favoritos las que utiliza a diario.