n8n/packages/@n8n/json-schema-to-zod
2024-10-17 15:57:44 +03:00
..
src feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
test feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
.eslintrc.js feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
.gitignore feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
.npmignore feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
jest.config.js feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
LICENSE feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
package.json feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
postcjs.js feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
postesm.js feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
README.md feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
tsconfig.cjs.json feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
tsconfig.esm.json feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
tsconfig.json feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00
tsconfig.types.json feat: Add fork of json-schema-to-zod (no-changelog) (#11228) 2024-10-17 15:57:44 +03:00

Json-Schema-to-Zod

A package to convert JSON schema (draft 4+) objects into Zod schemas in the form of Zod objects at runtime.

Installation

npm install @n8n/json-schema-to-zod

Simple example

import { jsonSchemaToZod } from "json-schema-to-zod";

const jsonSchema = {
  type: "object",
  properties: {
    hello: {
      type: "string",
    },
  },
};

const zodSchema = jsonSchemaToZod(myObject);

Overriding a parser

You can pass a function to the overrideParser option, which represents a function that receives the current schema node and the reference object, and should return a zod object when it wants to replace a default output. If the default output should be used for the node just return undefined.

Acknowledgements

This is a fork of json-schema-to-zod.