JSON till TypeScript
Omvandla ett JSON-exempel till TypeScript-gränssnitt eller typalias. Nästlade objekt får egna namngivna typer, arrayer med objekt slås ihop så att nycklar som saknas i vissa objekt blir valfria, och blandade värden blir unionstyper. Klistra in ett API-svar, välj gränssnitt eller typ och kopiera deklarationer som du kan klistra in direkt i koden.
Vanliga frågor
Hur hanteras nästlade objekt?
Varje nästlat objekt får en egen deklaration, uppkallad efter nyckeln som innehåller det i PascalCase, till exempel blir address Address. Objekt i arrayer får namn efter arraynyckelns singularform, så users blir User och categories blir Category. Objekt med exakt samma fält delar deklaration.
När blir en egenskap valfri?
När en array innehåller flera objekt och en nyckel saknas i vissa av dem markeras nyckeln som valfri med ett frågetecken. Nycklar som finns i varje objekt förblir obligatoriska. Ett enskilt objekt har inga andra exempel att jämföra med, så alla dess nycklar är obligatoriska.
Hur typbestäms null-värden?
En nyckel som är null i ditt exempel typbestäms som null, och en nyckel som är null i vissa objekt och en sträng i andra blir string | null. Om ett fält kan vara null i verkliga data men aldrig är null i ditt exempel kan du lägga till null för hand eller klistra in ett exempel som innehåller det.
Ska jag välja interface eller type?
Båda beskriver samma form. Gränssnitt kan utökas och slås ihop, vilket många stilguider föredrar för objektformer; typalias fungerar också för unioner och används av vissa team överallt. Välj det som används i din kodbas; fälten är identiska.
Hur typbestäms arrayer?
En array med en typ av värde blir den typen med [] efter, till exempel string[] eller User[]. En array med flera typer blir en union inom parenteser, till exempel (string | number)[]. En tom array blir unknown[], eftersom exemplet inte säger något om dess objekt.
Vad händer med nycklar som inte är giltiga identifierare?
Nycklar med blanksteg, bindestreck eller andra tecken som inte tillåts i en TypeScript-identifierare skrivs inom citationstecken, till exempel "first-name": string, vilket är giltig TypeScript och exakt motsvarar JSON.
Typbestäms tal som heltal eller decimaltal?
TypeScript har en enda taltyp, så både heltal och decimaltal blir number. Om du behöver veta vilka värden som är heltal skiljer JSON Schema Generator mellan integer och number.
Kan jag byta namn på rot-typen?
Ja. Ange ett namn för rot-typen, till exempel ApiResponse. Det konverteras till PascalCase, och de nästlade typerna behåller namn som härleds från sina nycklar. När den översta nivån i ditt JSON är en array eller ett enskilt värde blir roten ett typalias för den.
Identifieras datum?
Nej. JSON har ingen datumtyp, så ett datum i ditt exempel är en sträng och typbestäms som string. Konvertera det till Date i koden efter parsningen, eller begränsa typen för hand om du använder en mallsträngstyp.
Hur stort kan JSON vara?
Upp till 1,000,000 tecken och nästlat till 64 nivåers djup. Exemplet analyseras bara för att ta fram typerna och sparas inte.