JSON do TypeScript
Premeňte ukážku JSON na rozhrania alebo aliasy typov TypeScript. Vnorené objekty sa zmenia na samostatné pomenované typy, polia objektov sa zlúčia tak, aby kľúče chýbajúce v niektorých položkách boli voliteľné, a zmiešané hodnoty sa zmenia na zjednotené typy. Vložte odpoveď API, vyberte rozhranie alebo typ a skopírujte deklarácie, ktoré môžete rovno vložiť do svojho kódu.
Často kladené otázky
Ako sa spracúvajú vnorené objekty?
Každý vnorený objekt dostane vlastnú deklaráciu pomenovanú podľa kľúča, ktorý ho obsahuje, v PascalCase; napríklad address sa zmení na Address. Objekty v poliach sa pomenujú podľa jednotného čísla kľúča poľa, takže users sa zmení na User a categories na Category. Objekty s presne rovnakými poľami zdieľajú jednu deklaráciu.
Kedy sa vlastnosť stáva voliteľnou?
Keď pole obsahuje viacero objektov a v niektorých z nich chýba kľúč, označí sa tento kľúč ako voliteľný pomocou otázniku. Kľúče, ktoré sa vyskytujú v každej položke, zostávajú povinné. Pri jednom objekte nie sú k dispozícii ďalšie ukážky na porovnanie, preto sú všetky jeho kľúče povinné.
Ako sa typujú hodnoty null?
Kľúč, ktorý má vo vašej ukážke hodnotu null, sa typuje ako null. Ak má kľúč v niektorých položkách hodnotu null a v iných reťazec, jeho typom bude string | null. Ak môže byť pole v skutočných údajoch null, ale vo vašej ukážke túto hodnotu nemá, pridajte null ručne alebo vložte ukážku, ktorá ju obsahuje.
Mám zvoliť interface alebo type?
Obe možnosti opisujú rovnaký tvar. Rozhrania možno rozširovať a spájať, čo mnohé štýlové príručky uprednostňujú pri tvaroch objektov; aliasy typov fungujú aj pre zjednotenia a niektoré tímy ich používajú všade. Vyberte si to, čo používa vaša kódová základňa; polia budú rovnaké.
Ako sa typujú polia?
Pole s jedným druhom hodnôt sa zmení na daný typ s [] za ním, napríklad string[] alebo User[]. Pole s viacerými druhmi hodnôt sa zmení na zjednotený typ v zátvorkách, napríklad (string | number)[]. Prázdne pole sa zmení na unknown[], pretože ukážka neobsahuje informácie o jeho položkách.
Čo sa stane s kľúčmi, ktoré nie sú platnými identifikátormi?
Kľúče s medzerami, pomlčkami alebo inými nepovolenými znakmi v identifikátore TypeScript sa zapisujú v úvodzovkách, napríklad "first-name": string. Takýto zápis je platný v TypeScript a presne zodpovedá JSON.
Typujú sa čísla ako celé čísla alebo desatinné čísla?
TypeScript má iba jeden číselný typ, takže celé aj desatinné čísla sa zmenia na number. Ak potrebujete rozlíšiť, ktoré hodnoty sú celé čísla, generátor schém JSON rozlišuje integer od number.
Môžem premenovať koreňový typ?
Áno. Zadajte názov koreňového typu, napríklad ApiResponse. Prevedie sa na PascalCase a vnorené typy si ponechajú názvy odvodené od svojich kľúčov. Ak je najvyššia úroveň vášho JSON pole alebo jedna hodnota, koreňový typ sa zmení na alias tohto typu.
Rozpoznávajú sa dátumy?
Nie. JSON nemá typ dátumu, takže dátum vo vašej ukážke je reťazec a typuje sa ako string. Po parsovaní ho v kóde preveďte na Date alebo typ zúžte ručne, ak používate typ šablónového literálu.
Aké veľké môže byť JSON?
Môže mať až 1,000,000 znakov a vnorenie do hĺbky 64 úrovní. Ukážka sa analyzuje iba na vytvorenie typov a neukladá sa.