Может ли Zod анализировать содержимое файлов JSON?

Это может быть дубликат Zod: Разобрать внешний файл JSON


У меня есть функция, которая ожидает строку JSON и анализирует ее до заданного типа, выведенного схемой Zod.

const createConfigurationFromJson = (content: string): Configuration => {
  const rawConfiguration = JSON.parse(content);

  return configurationSchema.parse(rawConfiguration);
};

Эта функция может выдать ошибку, если содержимое JSON является недопустимым JSON или Zod выдает ошибку синтаксического анализа. Можно ли позволить Zod анализировать строку JSON без использования другой сторонней библиотеки? Так что я могу быть уверен, что может быть только ошибка Зода?

Стоит ли изучать PHP в 2023-2024 годах?
Стоит ли изучать PHP в 2023-2024 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
0
0
180
2
Перейти к ответу Данный вопрос помечен как решенный

Ответы 2

Кажется, для этого нет пакета. Теоретически такой пакет будет делать чуть больше того, что вы уже делаете.

Может быть, вы могли бы окружить синтаксический анализ json блоком try catch и превратить общую ошибку в ошибку zod?

Ответ принят как подходящий

Если вы хотите, чтобы это было полностью в zod, создайте пользовательскую схему , которая возвращает true, если это допустимый json, иначе false. Затем, прежде чем вы сможете отправить это в configurationSchema, вам нужно преобразовать строку content в объект. Вы можете использовать .pipe, чтобы передать это configurationSchema.

const configurationSchema = z.object({
  name: z.string(),
  version: z.string(),
  description: z.string(),
});

type Configuration = z.infer<typeof configurationSchema>;

const createConfigurationFromJson = (content: string): Configuration => {
  return z
    .custom<string>((data) => {
      try {
        JSON.parse(content);
      } catch (error) {
        return false;
      }
      return true;
    }, "invalid json") // write whatever error you want here
    .transform((content) => JSON.parse(content))
    .pipe(configurationSchema)
    .parse(content);
};

(вы можете оптимизировать это, чтобы использовать сохраненное значение из первого JSON.parse, но это всего лишь преждевременная оптимизация, которая не повлияет на подавляющее большинство проектов)

При тестировании с

const configuration1 = createConfigurationFromJson(`{
  "name": "my-app",
  "version": "1.0.0",
  "description": "My awesome app"
}`);

const configuration2 = createConfigurationFromJson(`{
  "banana": "🍌"
}`);

const configuration3 = createConfigurationFromJson(`{
  fiadsjfoiajsdoivjdaoij
`);

он выводит успех и ошибки как

configuration1 {
  name: "my-app",
  version: "1.0.0",
  description: "My awesome app"
}
configuration2 159 |     const json = JSON.stringify(obj, null, 2);
160 |     return json.replace(/"([^"]+)":/g, "$1:");
161 | };
162 | class ZodError extends Error {
163 |     constructor(issues) {
164 |         super();
            ^
ZodError: [
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "undefined",
    "path": [
      "name"
    ],
    "message": "Required"
  },
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "undefined",
    "path": [
      "version"
    ],
    "message": "Required"
  },
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "undefined",
    "path": [
      "description"
    ],
    "message": "Required"
  }
]
 errors: [
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "undefined",
    "path": [
      "name"
    ],
    "message": "Required"
  },
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "undefined",
    "path": [
      "version"
    ],
    "message": "Required"
  },
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "undefined",
    "path": [
      "description"
    ],
    "message": "Required"
  }
]

      at new ZodError (/Users/sgunter/code/zod-parse-json/node_modules/zod/lib/index.mjs:164:8)
      at /Users/sgunter/code/zod-parse-json/node_modules/zod/lib/index.mjs:537:30
      at parse (/Users/sgunter/code/zod-parse-json/node_modules/zod/lib/index.mjs:636:14)
      at /Users/sgunter/code/zod-parse-json/index.ts:46:25

configuration3 159 |     const json = JSON.stringify(obj, null, 2);
160 |     return json.replace(/"([^"]+)":/g, "$1:");
161 | };
162 | class ZodError extends Error {
163 |     constructor(issues) {
164 |         super();
            ^
ZodError: [
  {
    "code": "custom",
    "message": "invalid json",
    "fatal": true,
    "path": []
  }
]
 errors: [
  {
    "code": "custom",
    "message": "invalid json",
    "fatal": true,
    "path": []
  }
]

      at new ZodError (/Users/sgunter/code/zod-parse-json/node_modules/zod/lib/index.mjs:164:8)
      at /Users/sgunter/code/zod-parse-json/node_modules/zod/lib/index.mjs:537:30
      at parse (/Users/sgunter/code/zod-parse-json/node_modules/zod/lib/index.mjs:636:14)
      at /Users/sgunter/code/zod-parse-json/index.ts:55:25

Другие вопросы по теме