Converti JSON in tipi io-ts — Numio

Quando usarlo

• Convalida di una risposta API in fase di runtime in un'app TypeScript basata su fp-ts e io-ts.
• Codec di redazione per un file di configurazione JSON che deve essere controllato prima dell'uso.

Come si usa

1. Incolla un oggetto JSON; includere diversi elementi dell'array se alcune chiavi sono facoltative.
2. Leggi i codec generati: la radice è RootInterface e quelli annidati prendono il nome dalle loro chiavi (le impostazioni diventano Impostazioni).
3. Copia il codice, esporta i codec che ti servono e deriva i tipi con 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),
})

Dettagli e limiti

Generato nel browser dal generatore stesso del sito e formattato con Prettier; la pagina non ha impostazioni e non effettua richieste al server.

I codec vengono prima emessi come dipendenze, quindi ogni const viene definito prima che RootInterface vi faccia riferimento.

I numeri diventano t.number (interi e decimali allo stesso modo). null restituisce t.null o t.union([X, t.null]) quando altri campioni hanno un valore; gli array vuoti danno t.array(t.unknown).

Le chiavi mancanti in alcuni elementi di un array vanno in t.partial, combinate con le chiavi richieste tramite t.intersection.

FAQ

Strumenti correlati

Specifiche e riferimenti

• io-ts su GitHub