YAML til TypeScript-konverterer
Generer TypeScript-grensesnitt fra YAML-data
YAML-inndata
TypeScript-utdata
Hva er YAML til TypeScript?
TypeScript bruker grensesnitt og typer for struktur. Dette verktøyet genererer TypeScript-grensesnitt fra YAML-en din slik at du kan typet parset konfigurasjon eller data. YAML 1.2-spesifikasjonen definerer inngangsformatet.
Konvertering kjører i nettleseren din. Ingenting sendes til en server. De genererte typene fungerer med parsere som js-yaml eller yaml-pakken. For JSON til TypeScript, bruk JSON til TypeScript.
Eksempler på YAML til TypeScript
Generer TypeScript-grensesnitt fra YAML. Telecom-tematisert eksempel:
Eksempel: Abonnementspost
TypeScript-utdata:
Klikk på Eksempel-knappen ovenfor for å laste inn flere eksempler i editoren.
Slik bruker du verktøyet
Lim inn eller last opp YAML
Kopier YAML-en din og lim den inn i editoren til venstre. Du kan også klikke Last opp for å laste inn en .yaml- eller .yml-fil. Eksempel-knappen laster inn eksempeldata. Ugyldig YAML viser en feil.
Kopier eller last ned
Bruk Kopier eller Last ned. For JSON til TypeScript, bruk JSON til TypeScript. For YAML-formatering, bruk YAML-formatereren.
Når YAML til TypeScript hjelper
Når man bygger Node.js- eller frontend-apper som laster YAML-konfigurasjon (f.eks. config.yml, Kubernetes-manifester eller CI-arbeidsflyter), trenger du typede strukturer for de parsede dataene. Å lime inn et eksempel her gir deg TypeScript-grensesnitt du kan bruke med js-yaml eller yaml-pakken. Å skrive typer for kompleks nestet YAML manuelt er kjedelig; dette verktøyet utleder strukturen fra eksempelet ditt.
Konfigurasjonsfiler som application.yml eller GitHub Actions-arbeidsflyter har ofte dyp nesting. De genererte typene hjelper med å fange opp skrivefeil og gir autokompletering i IDE-en din. For å trekke ut spesifikke verdier fra stor YAML, konverter til JSON først og bruk jq.
Ofte stilte spørsmål
Hvordan parser jeg YAML i TypeScript?
Bruk js-yaml eller yaml-pakken. Parser YAML-strengen og tildel til den genererte typen: const config = yaml.parse(str) as MyConfig. For kjøretidsvalidering, vurder Zod eller io-ts.
js-yaml vs yaml-pakken?
js-yaml er mye brukt. yaml-pakken har et annet API og bedre kommentarbevaring. Begge fungerer med de genererte typene.
Er dataene mine private?
Ja. Generering kjører helt i nettleseren din. Ingen YAML eller kode sendes til noen server.
Valgfrie vs påkrevde felt?
Generatoren utleder fra eksempelet. Legg til ? til grensesnittegenskaper for valgfrie felt. For streng kjøretidsvalidering, bruk Zod eller lignende med de genererte typene som referanse.
Kan jeg bruke med Angular eller React?
Ja. De genererte typene fungerer i alle TypeScript-prosjekter. Last inn YAML ved byggetid eller kjøretid og cast til det genererte grensesnittet. For miljøkonfigurasjon, vurder å laste YAML i en konfigureringstjeneste.
Relaterte verktøy
TypeScript-dokumentasjon. YAML-spesifikasjonen. js-yaml. JSON-spesifikasjonen. MDN.