Class: JSONSchemaGenerator

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:32

Legacy class-based interface for JSON Schema generation. This class wraps the new functional implementation to provide backward compatibility.

Deprecated

Use the toJSONSchema function instead for new code.

Example

// Legacy usage (still supported)
const gen = new JSONSchemaGenerator({ target: "draft-07" });
gen.process(schema);
const result = gen.emit(schema);

// Preferred modern usage
const result = toJSONSchema(schema, { target: "draft-07" });

Accessors

metadataRegistry

Get Signature

get metadataRegistry(): $ZodRegistry<Record<string, any>>;

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:35

Deprecated

Access via ctx instead

Returns

$ZodRegistry<Record<string, any>>

---

target

Get Signature

get target(): 
  | "draft-04"
  | "draft-07"
  | "draft-2020-12"
  | "openapi-3.0"
  | {
} & string;

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:37

Deprecated

Access via ctx instead

Returns

| "draft-04" | "draft-07" | "draft-2020-12" | "openapi-3.0" | { } & string

---

unrepresentable

Get Signature

get unrepresentable(): "any" | "throw";

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:39

Deprecated

Access via ctx instead

Returns

"any" | "throw"

---

override

Get Signature

get override(): (ctx: {
  zodSchema: $ZodType;
  jsonSchema: JSONSchema;
  path: (string | number)[];
}) => void;

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:41

Deprecated

Access via ctx instead

Returns

(ctx: {
  zodSchema: $ZodType;
  jsonSchema: JSONSchema;
  path: (string | number)[];
}): void;

Parameters

Parameter	Type
ctx	{ zodSchema: $ZodType; jsonSchema: JSONSchema; path: (string | number)[]; }
ctx.zodSchema	$ZodType
ctx.jsonSchema	JSONSchema
ctx.path	(string | number)[]

Returns

void

---

io

Get Signature

get io(): "input" | "output";

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:47

Deprecated

Access via ctx instead

Returns

"input" | "output"

---

counter

Get Signature

get counter(): number;

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:49

Deprecated

Access via ctx instead

Returns

number

---

seen

Get Signature

get seen(): Map<$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, Seen>;

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:52

Deprecated

Access via ctx instead

Returns

Map<$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, Seen>

Methods

process()

process(schema: $ZodType, _params?: ProcessParams): JSONSchema;

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:58

Process a schema to prepare it for JSON Schema generation. This must be called before emit().

Parameters

Parameter	Type
schema	$ZodType
_params?	ProcessParams

Returns

JSONSchema

---

emit()

emit(schema: $ZodType, _params?: EmitParams): JSONSchema;

Defined in: node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/json-schema-generator.d.cts:63

Emit the final JSON Schema after processing. Must call process() first.

Parameters

Parameter	Type
schema	$ZodType
_params?	EmitParams

Returns

JSONSchema