Converter JSON em tipos io-ts — Numio

Quando usar

• Validar em runtime a resposta de uma API em um app TypeScript construído com fp-ts e io-ts.
• Rascunhar codecs para um arquivo de configuração JSON que precisa ser verificado antes do uso.

Como usar

1. Cole um objeto JSON; inclua vários itens de array se algumas chaves forem opcionais.
2. Confira os codecs gerados: a raiz é RootInterface e os aninhados recebem o nome da chave (settings vira Settings).
3. Copie o código, exporte os codecs de que precisar e derive os tipos com t.TypeOf.

{
  "id": "u_1",
  "name": "Ada",
  "age": 36,
  "nickname": null,
  "settings": { "theme": "dark", "fontSize": 14 },
  "posts": [
    { "title": "Notes", "draft": true },
    { "title": "Engine" }
  ]
}

import * as t from "io-ts"

const Settings = t.type({
  theme: t.string,
  fontSize: t.number,
})

const Posts = t.intersection([
  t.type({
    title: t.string,
  }),
  t.partial({
    draft: t.boolean,
  }),
])

const RootInterface = t.type({
  id: t.string,
  name: t.string,
  age: t.number,
  nickname: t.null,
  settings: Settings,
  posts: t.array(Posts),
})

Detalhes e limitações

Gerado no navegador pelo gerador próprio do site e formatado com Prettier; a página não tem configurações e não faz requisições ao servidor.

Os codecs são emitidos com as dependências primeiro, então cada const está definida antes de RootInterface referenciá-la.

Números viram t.number (inteiros e decimais). null gera t.null, ou t.union([X, t.null]) quando outras amostras têm um valor; arrays vazios geram t.array(t.unknown).

Chaves ausentes em alguns itens de um array vão para t.partial, combinado com as chaves obrigatórias por meio de t.intersection.

FAQ

Ferramentas relacionadas

Especificações e referências

• io-ts on GitHub