JSON → TypeScript
Alakítson át egy JSON mintát TypeScript interfészekké vagy típusaliasokká. A beágyazott objektumok saját, névvel ellátott típusokat kapnak, az objektumokat tartalmazó tömbök pedig összevonásra kerülnek, így az egyes elemekből hiányzó kulcsok opcionálissá válnak, a vegyes értékekből pedig uniótípusok lesznek. Illesszen be egy API-választ, válassza az interface vagy type lehetőséget, majd másolja ki a közvetlenül a kódba illeszthető deklarációkat.
Gyakran ismételt kérdések
Hogyan kezeli a beágyazott objektumokat?
Minden beágyazott objektum saját deklarációt kap, amelynek neve az őt tartalmazó kulcs PascalCase alakja; például az address neve Address lesz. A tömbökben lévő objektumok a tömbkulcs egyes számú alakja alapján kapnak nevet, így a users neve User, a categories neve pedig Category lesz. A pontosan azonos mezőkkel rendelkező objektumok egy deklarációt használnak.
Mikor válik egy tulajdonság opcionálissá?
Ha egy tömb több objektumot tartalmaz, és egy kulcs némelyikből hiányzik, akkor kérdőjellel jelölt opcionális kulccsá válik. A minden elemben szereplő kulcsok kötelezők maradnak. Egyetlen objektumot nem lehet más mintákkal összehasonlítani, ezért minden kulcsa kötelező.
Hogyan történik a null értékek típusozása?
A mintában null értékű kulcs típusa null lesz, ha pedig egyes elemekben null, másokban pedig string az értéke, akkor string | null lesz. Ha a mező a valós adatokban lehet null, de a mintában sosem az, adja hozzá kézzel a null típust, vagy illesszen be olyan mintát, amely tartalmazza.
Az interface-t vagy a type-ot válasszam?
Mindkettő ugyanazt a struktúrát írja le. Az interface-ek kiterjeszthetők és összevonhatók, ezért sok stílusútmutató ezt részesíti előnyben az objektumok leírásához; a type aliasok uniókhoz is használhatók, és vannak csapatok, amelyek mindenhol ezeket alkalmazzák. Válassza azt, amelyiket a kódbázisa használja; a mezők azonosak.
Hogyan típusozza a tömböket?
Az egyféle értéket tartalmazó tömb típusa az adott típus, utána [] jellel, például string[] vagy User[]. A többféle értéket tartalmazó tömb típusa zárójelbe tett unió, például (string | number)[]. Az üres tömb típusa unknown[], mivel a minta nem árul el semmit az elemeiről.
Mi történik az érvénytelen azonosítóknak számító kulcsokkal?
A szóközt, kötőjelet vagy más, TypeScript-azonosítóban nem engedélyezett karaktereket tartalmazó kulcsok idézőjelek között szerepelnek, például "first-name": string. Ez érvényes TypeScript, és pontosan megfelel a JSON-nak.
A számok típusa egész vagy lebegőpontos?
A TypeScript egyetlen számtípust használ, így az egész és a tizedes számok típusa egyaránt number lesz. Ha tudnia kell, mely értékek egész számok, a JSON sémagenerátor megkülönbözteti az integer és number típusokat.
Átnevezhetem a gyökértípust?
Igen. Adjon nevet a gyökértípusnak, például ApiResponse. A név PascalCase alakú lesz, a beágyazott típusok pedig továbbra is a kulcsaikból származó nevet kapják. Ha a JSON legfelső szintje tömb vagy egyetlen érték, a gyökér annak típusaliasa lesz.
Felismeri a dátumokat?
Nem. A JSON-nak nincs dátumtípusa, ezért a mintában szereplő dátum string típusú lesz. Feldolgozás után alakítsa Date típussá a kódban, vagy szűkítse kézzel a típust, ha sablonszöveg-típust használ.
Mekkora lehet a JSON?
Legfeljebb 1,000,000 karakter hosszú és 64 szint mélyen beágyazott lehet. A mintát csak a típusok előállításához elemzi a rendszer, és nem tárolja.