JSON uz TypeScript
Pārvērtiet JSON paraugu par TypeScript saskarnēm vai tipu aizstājvārdiem. Ligzdotie objekti kļūst par atsevišķiem nosauktiem tipiem, objektu masīvi tiek apvienoti, lai atslēgas, kas trūkst dažos elementos, kļūtu neobligātas, bet jauktas vērtības kļūst par apvienojuma tipiem. Ielīmējiet API atbildi, izvēlieties saskarni vai tipu un kopējiet deklarācijas, ko varat uzreiz ievietot savā kodā.
Bieži uzdotie jautājumi
Kā tiek apstrādāti ligzdoti objekti?
Katrs ligzdotais objekts saņem savu deklarāciju, kas nosaukta pēc atslēgas, kurā tas atrodas, izmantojot PascalCase, piemēram, address kļūst par Address. Masīvos esošie objekti tiek nosaukti pēc masīva atslēgas vienskaitļa formas, tāpēc users kļūst par User, bet categories — par Category. Objektiem ar pilnīgi vienādiem laukiem ir viena kopīga deklarācija.
Kad īpašums kļūst neobligāts?
Ja masīvā ir vairāki objekti un kādā no tiem trūkst atslēgas, šī atslēga tiek atzīmēta kā neobligāta ar jautājuma zīmi. Atslēgas, kas ir katrā elementā, paliek obligātas. Vienam objektam nav citu paraugu salīdzināšanai, tāpēc visas tā atslēgas ir obligātas.
Kā tiek norādīti null vērtību tipi?
Atslēgai, kuras vērtība paraugā ir null, tiek piešķirts tips null, bet atslēga, kuras vērtība dažos elementos ir null un citos — virkne, iegūst tipu string | null. Ja reālos datos lauks var būt null, bet jūsu paraugā tā nav, pievienojiet null manuāli vai ielīmējiet paraugu, kurā tā ir.
Vai izvēlēties interface vai type?
Abi apraksta vienādu struktūru. Saskarnes var paplašināt un apvienot, un daudzas stila rokasgrāmatas tās dod priekšroku objektu struktūrām; tipu aizstājvārdi darbojas arī apvienojumiem, un dažas komandas tos izmanto visur. Izvēlieties to, ko izmanto jūsu koda bāze; lauki būs identiski.
Kā tiek norādīti masīvu tipi?
Viena veida vērtību masīvs kļūst par attiecīgo tipu ar [] aiz tā, piemēram, string[] vai User[]. Vairāku veidu masīvs kļūst par apvienojumu iekavās, piemēram, (string | number)[]. Tukšs masīvs kļūst par unknown[], jo paraugā nav informācijas par tā elementiem.
Kas notiek ar atslēgām, kas nav derīgi identifikatori?
Atslēgas ar atstarpēm, defisēm vai citām neatļautām rakstzīmēm TypeScript identifikatorā tiek rakstītas pēdiņās, piemēram, "first-name": string. Tas ir derīgs TypeScript un precīzi atbilst JSON.
Vai skaitļi tiek norādīti kā veseli vai peldošā komata skaitļi?
TypeScript ir tikai viens skaitļa tips, tāpēc gan veseli, gan decimālskaitļi kļūst par number. Ja jānoskaidro, kuras vērtības ir veseli skaitļi, JSON shēmas ģenerators nošķir integer no number.
Vai varu pārdēvēt saknes tipu?
Jā. Ievadiet saknes tipa nosaukumu, piemēram, ApiResponse. Tas tiek pārveidots PascalCase formā, bet ligzdotie tipi saglabā nosaukumus, kas atvasināti no to atslēgām. Ja jūsu JSON augšējais līmenis ir masīvs vai viena vērtība, sakne kļūst par tās tipa aizstājvārdu.
Vai tiek noteikti datumi?
Nē. JSON nav datuma tipa, tāpēc datums paraugā ir virkne, un tā tips ir string. Pēc parsēšanas pārveidojiet to par Date savā kodā vai sašauriniet tipu manuāli, ja izmantojat veidnes virknes tipu.
Cik liels var būt JSON?
Līdz 1,000,000 rakstzīmēm, ligzdojums — līdz 64 līmeņiem. Paraugs tiek analizēts tikai tipu izveidei un netiek saglabāts.