Konwertuj JSON na typy io-ts — Numio

Kiedy go używać

• Sprawdzanie poprawności odpowiedzi API w czasie wykonywania w aplikacji TypeScript zbudowanej na fp-ts i io-ts.
• Tworzenie kodeków dla pliku konfiguracyjnego JSON, które należy sprawdzić przed użyciem.

Jak używać

1. Wklej obiekt JSON; zawierać kilka elementów tablicy, jeśli niektóre klucze są opcjonalne.
2. Przeczytaj wygenerowane kodeki: katalog główny to RootInterface, a zagnieżdżone mają nazwy odpowiadające ich kluczom (ustawienia stają się Ustawieniami).
3. Skopiuj kod, wyeksportuj potrzebne kodeki i uzyskaj typy za pomocą 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),
})

Szczegóły i ograniczenia

Wygenerowane w przeglądarce przez własny generator witryny i sformatowane w Prettier; strona nie ma żadnych ustawień i nie wysyła żadnych żądań do serwera.

Kodeki są emitowane z zależnościami na początku, więc każda deklaracja const istnieje, zanim RootInterface się do niej odwoła.

Liczby stają się t.number (zarówno całkowite, jak i dziesiętne). null daje t.null albo t.union([X, t.null]), gdy inne próbki zawierają wartość; puste tablice dają t.array(t.unknown).

Brakujące klucze w niektórych elementach tablicy trafiają do t.partial, łączone z wymaganymi kluczami poprzez t.intersection.

FAQ

Powiązane narzędzia

Specyfikacje i referencje

• io-ts na GitHub