JSON → TypeScript
Muunna JSON-esimerkki TypeScript-rajapinnoiksi tai tyyppialiaksiksi. Sisäkkäisistä objekteista tulee omat nimetyt tyypit, objektitaulukot yhdistetään niin, että joistakin alkioista puuttuvat avaimet merkitään valinnaisiksi, ja eri tyyppiset arvot muodostavat unionityyppejä. Liitä API-vastaus, valitse interface tai type ja kopioi määrittelyt suoraan koodiisi.
Usein kysytyt kysymykset
Miten sisäkkäisiä objekteja käsitellään?
Jokaisesta sisäkkäisestä objektista luodaan oma määrittely, joka nimetään sitä sisältävän avaimen mukaan PascalCase-muodossa; esimerkiksi address-nimestä tulee Address. Taulukoiden sisällä olevat objektit nimetään taulukon avaimen yksikkömuodon mukaan, joten users-nimestä tulee User ja categories-nimestä Category. Täsmälleen samat kentät sisältävät objektit jakavat saman määrittelyn.
Milloin ominaisuus merkitään valinnaiseksi?
Jos taulukko sisältää useita objekteja ja jokin avain puuttuu osasta niitä, avain merkitään kysymysmerkillä valinnaiseksi. Kaikissa alkioissa esiintyvät avaimet pysyvät pakollisina. Yksittäiselle objektille ei ole muita näytteitä vertailtavaksi, joten kaikki sen avaimet ovat pakollisia.
Miten null-arvot tyypitetään?
Jos näytteessäsi avaimen arvo on null, sen tyypiksi tulee null. Jos arvo on joissakin alkioissa null ja toisissa merkkijono, tyypiksi tulee string | null. Jos kenttä voi oikeassa datassa olla null mutta ei ole sitä näytteessäsi, lisää null käsin tai liitä näyte, joka sisältää sen.
Valitsenko interfacen vai typen?
Molemmilla voi kuvata saman rakenteen. Interface-määrittelyjä voi laajentaa ja yhdistää, mitä monet tyylioppaat suosittelevat objektien rakenteisiin. Type-aliasit sopivat myös unioneihin, ja jotkin tiimit käyttävät niitä kaikkeen. Valitse koodikantasi käytäntöjen mukaan; kentät ovat samat.
Miten taulukot tyypitetään?
Yhdenlaisen arvon taulukon tyypiksi tulee kyseinen tyyppi, jonka perään lisätään [], kuten string[] tai User[]. Useita erilaisia arvoja sisältävän taulukon tyyppi on sulkeisiin kirjoitettu unioni, kuten (string | number)[]. Tyhjän taulukon tyypiksi tulee unknown[], koska näyte ei kerro sen alkioista mitään.
Mitä tapahtuu avaimille, jotka eivät ole kelvollisia tunnisteita?
Avaimet, joissa on välilyöntejä, väliviivoja tai muita merkkejä, joita TypeScript-tunnisteessa ei sallita, kirjoitetaan lainausmerkkeihin. Esimerkiksi "first-name": string on kelvollinen TypeScript, ja se vastaa täsmälleen JSON-rakennetta.
Tyypitetäänkö luvut kokonais- vai desimaaliluvuiksi?
TypeScript sisältää yhden numerotyypin, joten sekä kokonaisluvuista että desimaaliluvuista tulee number. Jos haluat erottaa kokonaisluvut, JSON Schema Generator erottaa integer- ja number-tyypit toisistaan.
Voinko nimetä juurityypin uudelleen?
Kyllä. Anna juurityypille nimi, kuten ApiResponse. Nimi muunnetaan PascalCase-muotoon, ja sisäkkäisten tyyppien nimet johdetaan niiden avaimista. Jos JSON-näytteesi ylin taso on taulukko tai yksittäinen arvo, juuresta tulee sen tyyppialias.
Tunnistetaanko päivämäärät?
Ei. JSON ei sisällä päivämäärätyyppiä, joten näytteessäsi oleva päivämäärä on merkkijono ja sen tyypiksi tulee string. Muunna se koodissasi Date-olioksi jäsentämisen jälkeen tai rajaa tyyppiä käsin, jos käytät template literal -tyyppiä.
Kuinka suuri JSON voi olla?
Enintään 1,000,000 merkkiä ja sisäkkäisyyttä voi olla enintään 64 tasoa. Näyte analysoidaan vain tyyppien tuottamista varten, eikä sitä tallenneta.