JSON in io-ts-Typen umwandeln — Numio

Wann sie hilft

• Eine API-Antwort zur Laufzeit in einer TypeScript-App auf Basis von fp-ts und io-ts validieren.
• Codecs für eine JSON-Konfigurationsdatei entwerfen, die vor der Verwendung geprüft werden muss.

Anwendung

1. Füge ein JSON-Objekt ein; nimm mehrere Array-Elemente auf, wenn einige Schlüssel optional sind.
2. Lies die erzeugten Codecs: Die Root heißt RootInterface, verschachtelte werden nach ihren Schlüsseln benannt (settings wird zu Settings).
3. Kopiere den Code, exportiere die benötigten Codecs und leite Typen mit t.TypeOf ab.

{
  "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),
})

Details und Einschränkungen

Wird im Browser vom eigenen Generator der Seite erzeugt und mit Prettier formatiert; die Seite hat keine Einstellungen und stellt keine Serveranfrage.

Codecs werden mit den Abhängigkeiten zuerst ausgegeben, sodass jede const definiert ist, bevor RootInterface sie referenziert.

Zahlen werden zu t.number (ganze und Dezimalzahlen gleichermaßen). null ergibt t.null, oder t.union([X, t.null]), wenn andere Beispiele einen Wert haben; leere Arrays ergeben t.array(t.unknown).

Schlüssel, die in einigen Elementen eines Arrays fehlen, kommen in t.partial und werden über t.intersection mit den Pflichtschlüsseln kombiniert.

FAQ

Ähnliche Tools

Spezifikationen und Referenzen

• io-ts on GitHub