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 отправляется на сервер только для генерации кода по этому запросу и не сохраняется. Генератор считывает только структуру образца и типы значений, поэтому перед вставкой вы можете заменить конфиденциальные значения заполнителями того же типа.