JSON у TypeScript
Перетворіть зразок JSON на інтерфейси або псевдоніми типів TypeScript. Вкладені об’єкти отримують власні іменовані типи, масиви об’єктів об’єднуються, тож ключі, яких бракує в деяких елементах, стають необов’язковими, а значення різних типів утворюють об’єднані типи. Вставте відповідь API, виберіть інтерфейс або тип і скопіюйте оголошення, які можна одразу вставити у свій код.
Поширені запитання
Як обробляються вкладені об’єкти?
Кожен вкладений об’єкт отримує власне оголошення з назвою за ключем, що його містить, у 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.
Числа типізуються як integer чи float?
У TypeScript є лише один числовий тип, тому і цілі, і десяткові числа стають number. Якщо потрібно розрізняти цілі числа, скористайтеся Генератором схем JSON.
Чи можна перейменувати кореневий тип?
Так. Введіть назву кореневого типу, наприклад ApiResponse. Її буде перетворено на PascalCase, а вкладені типи збережуть назви, утворені від їхніх ключів. Якщо верхній рівень вашого JSON — це масив або окреме значення, кореневий тип стане його псевдонімом.
Чи розпізнаються дати?
Ні. У JSON немає типу дати, тому дата у вашому зразку є рядком і матиме тип string. Після розбору перетворіть її на Date у своєму коді або вручну звузьте тип, якщо використовуєте тип із шаблонним рядком.
Який максимальний розмір JSON?
До 1,000,000 символів і до 64 рівнів вкладеності. Зразок аналізується лише для створення типів і не зберігається.