JSON към TypeScript
Преобразувайте примерен JSON в интерфейси или псевдоними на типове в TypeScript. Вложените обекти стават самостоятелни именувани типове, масивите от обекти се обединяват, така че липсващите в някои елементи ключове стават незадължителни, а смесените стойности стават обединени типове. Поставете отговор от API, изберете interface или type и копирайте декларациите, които можете да добавите директно в кода си.
Често задавани въпроси
Как се обработват вложените обекти?
Всеки вложен обект получава собствена декларация с име, образувано от ключа, който го съдържа, в PascalCase; например address става Address. Обектите в масиви получават имена от ключа на масива в единствено число, така че users става User, а categories — Category. Обектите с напълно еднакви полета споделят една декларация.
Кога дадено свойство става незадължително?
Когато масив съдържа няколко обекта и в някои от тях липсва ключ, този ключ се отбелязва като незадължителен с въпросителен знак. Ключовете, които присъстват във всеки елемент, остават задължителни. При един обект няма други примери за сравнение, затова всичките му ключове са задължителни.
Как се задават типове на стойностите null?
Ключ, чиято стойност в примера е null, получава тип null, а ключ, чиято стойност е null в някои елементи и низ в други, получава тип string | null. Ако дадено поле може да е null в реалните данни, но в примера ви никога не е, добавете null ръчно или поставете пример, който го съдържа.
Да избера ли interface или type?
И двете описват една и съща структура. Интерфейсите могат да се разширяват и обединяват, затова много ръководства за стил ги предпочитат за структури на обекти; псевдонимите на типове работят и за обединения и някои екипи ги използват навсякъде. Изберете това, което използва вашата кодова база; полетата са еднакви.
Как се задават типове на масивите?
Масив от един вид стойности получава съответния тип със [] след него, например string[] или User[]. Масив с няколко вида стойности става обединение в скоби, например (string | number)[]. Празният масив става unknown[], защото примерът не предоставя информация за елементите му.
Какво става с ключове, които не са валидни идентификатори?
Ключовете с интервали, тирета или други знаци, които не са позволени в идентификатор на TypeScript, се ограждат с кавички, например "first-name": string. Това е валиден TypeScript и съвпада точно с JSON.
Числата задават ли се като цели или десетични?
TypeScript има един тип за числа, така че и целите, и десетичните числа стават number. Ако трябва да знаете кои стойности са цели числа, генераторът на схеми JSON разграничава integer от number.
Мога ли да преименувам коренния тип?
Да. Въведете име за коренния тип, например ApiResponse. То се преобразува в PascalCase, а вложените типове запазват имената, получени от ключовете си. Когато най-горното ниво на вашия JSON е масив или единична стойност, коренният тип става псевдоним на тип за него.
Разпознават ли се датите?
Не. JSON няма тип за дата, затова датата в примера ви е низ и получава тип string. Преобразувайте я в Date в кода си след парсването или стеснете типа ръчно, ако използвате шаблонен литерален тип.
Колко голям може да бъде JSON?
До 1,000,000 знака и с вложеност до 64 нива. Примерът се анализира само за генериране на типовете и не се съхранява.