JSON у Zod
Генеруйте схеми Zod на основі зразка JSON. Вкладені об’єкти стають окремими експортованими схемами, ключі, відсутні в деяких елементах масиву, стають .optional(), значення null — .nullable(), а змішані значення — z.union. Кожна схема також отримує псевдонім типу z.infer, тож ви отримуєте перевірку під час виконання та типи TypeScript, вставивши лише один зразок.
Поширені запитання
Як називаються вкладені об’єкти?
Кожен вкладений об’єкт стає окремим типом Zod, названим за ключем, у якому він міститься, у PascalCase, наприклад address стає Address. Об’єкти в масивах отримують однину від ключа масиву, наприклад users стає User. Об’єкти з абсолютно однаковими полями спільно використовують один тип.
Коли поле є необов’язковим?
Якщо масив містить кілька об’єктів і в деяких із них немає певного ключа, це поле є необов’язковим: схема додає .optional(). Ключ, наявний у кожному зразку, є обов’язковим. Для одного об’єкта немає з чим порівнювати, тому всі його ключі обов’язкові.
Як обробляються значення null?
Ключ, який у деяких зразках має значення null, а в інших — певне значення, стає типом із .nullable(). Якщо ключ завжди має значення null, інструмент не може визначити його справжній тип, тому він стає z.null(); вставте зразок із реальним значенням, щоб отримати точний тип.
Які числові типи використовуються?
Цілі числа стають z.number().int(), а дробові — z.number(). Якщо одне поле містить числа обох типів, схема використовує z.number(), оскільки будь-яке ціле число також є допустимим числом.
Що відбувається з ключами, які не є допустимими іменами?
Ключі, які не є допустимими ідентифікаторами JavaScript, як-от first-name, беруться в лапки в z.object, тож схема точно відповідає початковим ключам JSON.
Чи завантажується або зберігається мій JSON?
JSON надсилається на сервер лише для генерації коду для цього запиту й не зберігається. Генератор читає лише структуру та типи значень у вашому зразку, тож перед вставленням ви можете замінити конфіденційні значення на заповнювачі того самого типу.