JSON til TypeScript
Lav TypeScript-interfaces eller typealiaser ud fra et JSON-eksempel. Indlejrede objekter bliver til deres egne navngivne typer, arrays af objekter flettes sammen, så nøgler, der mangler i nogle elementer, bliver valgfrie, og blandede værdier bliver til unionstyper. Indsæt et API-svar, vælg interface eller type, og kopiér deklarationer, du kan indsætte direkte i din kode.
Ofte stillede spørgsmål
Hvordan håndteres indlejrede objekter?
Hvert indlejret objekt får sin egen deklaration, der navngives efter nøglen, som indeholder det, i PascalCase; for eksempel bliver address til Address. Objekter i arrays navngives efter entalsformen af arrayets nøgle, så users bliver til User og categories til Category. Objekter med præcis de samme felter deler én deklaration.
Hvornår bliver en egenskab valgfri?
Når et array indeholder flere objekter, og en nøgle mangler i nogle af dem, markeres nøglen som valgfri med et spørgsmålstegn. Nøgler, der findes i hvert element, forbliver påkrævede. Et enkelt objekt har ingen andre eksempler at sammenligne med, så alle dets nøgler er påkrævede.
Hvordan types null-værdier?
En nøgle, der er null i dit eksempel, types som null, og en nøgle, der er null i nogle elementer og en streng i andre, bliver til string | null. Hvis et felt kan være null i rigtige data, men aldrig er null i dit eksempel, kan du selv tilføje null eller indsætte et eksempel, der indeholder det.
Skal jeg vælge interface eller type?
Begge beskriver den samme struktur. Interfaces kan udvides og flettes sammen, hvilket mange stilguider foretrækker til objektstrukturer; typealiaser fungerer også til unioner og bruges af nogle teams overalt. Vælg det, din kodebase bruger; felterne er identiske.
Hvordan types arrays?
Et array med én slags værdi bliver til den type med [] efter, f.eks. string[] eller User[]. Et array med flere slags bliver til en union i parenteser, f.eks. (string | number)[]. Et tomt array bliver til unknown[], fordi eksemplet ikke siger noget om dets elementer.
Hvad sker der med nøgler, der ikke er gyldige identifikatorer?
Nøgler med mellemrum, bindestreger eller andre tegn, der ikke er tilladt i en TypeScript-identifikator, skrives i anførselstegn, f.eks. "first-name": string, hvilket er gyldig TypeScript og matcher JSON præcist.
Types tal som heltal eller decimaltal?
TypeScript har én taltype, så både heltal og decimaltal bliver til number. Hvis du har brug for at vide, hvilke værdier der er heltal, skelner JSON Schema Generator mellem integer og number.
Kan jeg omdøbe rodtypen?
Ja. Angiv et navn til rodtypen, f.eks. ApiResponse. Det konverteres til PascalCase, og de indlejrede typer beholder navnene, der er afledt af deres nøgler. Når øverste niveau i din JSON er et array eller en enkelt værdi, bliver roden et typealias for det.
Registreres datoer?
Nej. JSON har ingen datotype, så en dato i dit eksempel er en streng og types som string. Konvertér den til en Date i din kode efter parsing, eller indsnævr typen manuelt, hvis du bruger en template literal-type.
Hvor stor kan JSON være?
Op til 1,000,000 tegn og indlejret op til 64 niveauer dybt. Eksemplet analyseres kun for at generere typerne og gemmes ikke.