YAML-syöte

TypeScript-tulos

Mikä on YAML TypeScriptiksi -muunnin?

TypeScript käyttää rajapintoja ja tyyppejä rakenteeseen. Tämä työkalu generoi TypeScript-rajapintoja YAML:stasi, jotta voit tyypittää jäsennetyn konfiguraation tai datan. YAML 1.2 -määrittely määrittelee syöteformaatin.

Muunnos toimii selaimessasi. Mitään ei lähetetä palvelimelle. Generoidut tyypit toimivat jäsentimien kanssa kuten js-yaml tai yaml-paketti. JSON TypeScriptiksi -muunnokseen käytä JSON TypeScriptiksi.

YAML TypeScriptiksi -esimerkkejä

Generoi TypeScript-rajapintoja YAML:sta. Telecom-teemainen esimerkki:

Esimerkki: Tilaajatietue

YAML-syöte

TypeScript-tulos:

TypeScript-tulos

Napsauta yllä olevaa Esimerkki-painiketta ladataksesi lisää esimerkkejä editoriin.

Miten työkalua käytetään

1

Liitä tai lataa YAML

Kopioi YAML ja liitä se vasempaan editoriin. Voit myös napsauttaa Lataa ladataksesi .yaml- tai .yml-tiedoston. Esimerkki-painike lataa esimerkkidataa. Virheellinen YAML näyttää virheilmoituksen.

2

Tarkista TypeScript-tulos

Oikea paneeli näyttää generoidut TypeScript-rajapinnat. Käytä js-yaml:n tai yaml-paketin kanssa konfiguraation jäsentämiseen ja tyypittämiseen. Säädä valinnaiset kentät käyttämään ?:ä tai unionityyppejä tarpeen mukaan.

3

Kopioi tai lataa

Käytä Kopioi tai Lataa tiedostona. JSON TypeScriptiksi -muunnokseen käytä JSON TypeScriptiksi. YAML:n muotoiluun käytä YAML-muotoilutyökalua.

Milloin YAML TypeScriptiksi -muunnos auttaa

Node.js- tai frontend-sovelluksia rakentaessa, jotka lataavat YAML-konfiguraation (esim. config.yml, Kubernetes-manifestit tai CI-työnkulut), tarvitset tyypitettyä rakennetta jäsennetylle datalle. Esimerkin liittäminen tähän antaa TypeScript-rajapinnat, joita voit käyttää js-yaml:n tai yaml-paketin kanssa. Monimutkaisen sisäkkäisen YAML:n tyyppien kirjoittaminen käsin on työlästä; työkalu päättelee rakenteen näytteestäsi.

Konfiguraatiotiedostot kuten application.yml tai GitHub Actions -työnkulut ovat usein syvästi sisennettyjä. Generoidut tyypit auttavat havaitsemaan kirjoitusvirheitä ja tarjoavat automaattitäydennyksen IDE:ssä. Tiettyjen arvojen poimintaan suuresta YAML:sta muunna ensin JSONiksi ja käytä jq:ta.

Usein kysyttyä

Miten jäsennetään YAML TypeScriptissa?

Käytä js-yaml:ä tai yaml-pakettia. Jäsennä YAML-merkkijono ja siirrä generoituun tyyppiin: const config = yaml.parse(str) as MyConfig. Ajonaikaiseen validointiin harkitse Zodia tai io-ts:ää.

js-yaml vs yaml-paketti?

js-yaml on laajasti käytetty. yaml-paketilla on erilainen API ja parempi kommenttien säilytys. Molemmat toimivat generoitujen tyyppien kanssa.

Onko datani yksityistä?

Kyllä. Generointi toimii kokonaan selaimessasi. Mitään YAML:ä tai koodia ei lähetetä palvelimelle.

Valinnaiset vs pakolliset kentät?

Generaattori päättelee näytteestä. Lisää ? rajapintaominaisuuksiin valinnaisille kentille. Tiukalle ajonaikaiselle validoinnille käytä Zodia tai vastaavaa generoitujen tyyppien viitteenä.

Voinko käyttää Angular- tai React-projekteissa?

Kyllä. Generoidut tyypit toimivat missä tahansa TypeScript-projektissa. Lataa YAML rakennusaikana tai ajonaikana ja sovita generoituun rajapintaan. Ympäristökonfiguraatiolle harkitse YAML:n lataamista konfiguraatiopalvelussa.

Liittyvät työkalut

TypeScript-dokumentaatio. YAML-määrittely. js-yaml. JSON-määrittely. MDN.