JSON a io-ts — decodifica y obtén el tipo

Qué hace esta herramienta

Una muestra JSON pasa a ser códecs de io-ts, un const por objeto.

{ "id": 1, "name": "Ada", "address": { "city": "Paris" } }

import * as t from "io-ts";

export const Address = t.type({
  city: t.string,
});

export const Root = t.type({
  id: t.Int,
  name: t.string,
  address: Address,
});

Los hijos se declaran primero: los códecs son valores de ejecución, uno debe existir antes de que otro lo mencione. Un array en la raíz recibe su propio códec —export const Users = t.array(UsersItem);— en vez de dejarte escribirlo.

t.Int es un tipo marcado, y se nota

t.Int es un refinamiento de t.number que lleva una prueba de integridad. t.TypeOf<typeof Root> da entonces { id: Int; … }, no { id: number; … }. Un Int va donde se espera un number; al revés hace falta un decode. Si ese roce no compensa el control de entero en tu base, t.number es un reemplazo de una palabra.

Cuál de los dos obtienes depende de cómo se escribió el número: 3 da t.Int, 10.0 da t.number. Hasta hace poco 10.0 también daba t.Int, y el códec rechazaba entonces 10.5, el registro siguiente. Era un defecto real, encontrado al escribir estas páginas y corregido.

Lo que un códec deja pasar

t.type comprueba lo que conoce e ignora el resto. Una respuesta con tres campos de más se decodifica limpiamente. Es la semántica de interfaz de io-ts, y es el buen valor por defecto para leer la API de otro; pero si una clave inesperada debe ser un error, envuelve la misma forma en t.strict, o en t.exact para quitarla.

Decodificar, en una línea

import { isRight } from "fp-ts/Either";

const result = Root.decode(payload);
if (isRight(result)) { /* result.right está tipado */ }

PathReporter.report(result) convierte un fallo en rutas legibles: viene bien la primera vez que un códec rechaza una carga que creías correcta.

Todo es obligatorio

Cada clave de la muestra aterriza en t.type, es decir, obligatoria. io-ts escribe la opcionalidad en un t.partial aparte, unido con t.intersection. Repartir tus claves entre las dos mitades es una afirmación sobre la API; un documento no puede hacerla por ti.

Privado por diseño

Todo se ejecuta localmente en tu navegador con JavaScript. Tus datos nunca se suben a un servidor, lo que hace que la herramienta sea segura para contenido sensible y funcione sin conexión.