Skip to content
EvolveEvolveEvolve

json-schema-to-zod API

Everything the package exports, by the path you import it from. Open an export for its signature and options.

@evolve-framework/json-schema-to-zod

writeZodTypes(entries, outputFile, schemaRootDir, schemaUrl?)

Functions

writeZodTypesWrite schema types to a file.
import { writeZodTypes } from "@evolve-framework/json-schema-to-zod";

It can read the following URI's:

  1. Local file system: file://
  2. HTTP/HTTPS: https:// or http://
  3. Custom replace with schemaRootDir: https://schemas.evolve.labdigital.nl

If the URI is not found, it will attempt to read any schema that is prefixed with the schemaUrl from the schemaRootDir instead. If this also fails, it will throw an error.

function writeZodTypes(
  entries: { uri: string; schemaName?: string | undefined; typeName?: string | undefined; }[],
  outputFile: string,
  schemaRootDir: string,
  schemaUrl?: string,
): Promise<void>

Returns Promise<void>