Zod schema introspection utilities.
Generic helpers for walking, unwrapping, and extracting metadata from Zod schemas. Used by CLI argument parsing, adversarial input testing, and surface generation.
18 declarations
(schema: ZodObject<$ZodLooseShape, $strip>): ZodFieldInfo[] Extract field metadata from a Zod object schema.
schemaZod object schema to extract from
ZodObject<$ZodLooseShape, $strip>ZodFieldInfo[] array of field info for each property
(value: unknown): string Format a value for display in help text.
valueValue to format.
unknownstring Formatted string representation.
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): string Get the base type name for a Zod schema, unwrapping all wrappers.
schemaZod schema to inspect
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>string base type name (e.g. 'string', 'object', 'uuid')
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): boolean Check if a schema has a default value at any wrapping level.
Unlike zod_to_schema_default (which returns the value), this returns a boolean. Distinguishes "no default" from "default is undefined".
schemaZod schema to check
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>boolean (schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): boolean Check if a schema accepts null at any wrapping level.
schemaZod schema to check
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>boolean (schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): boolean Check if a schema is optional at the outermost level.
schemaZod schema to check
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>boolean (schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): string[] Get aliases from a schema's metadata, unwrapping if needed.
schemaZod schema to extract aliases from.
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>string[] Array of alias strings.
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): unknown Get the default value from a schema, unwrapping if needed.
schemaZod schema to extract default from.
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>unknown Default value or undefined.
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): string | null Get the description from a schema's metadata, unwrapping if needed.
schemaZod schema to extract description from.
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>string | null Description string or null if not found.
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): Set<string> Get all property names and their aliases from an object schema.
schemaZod object schema.
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>Set<string> Set of all names and aliases.
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): ZodSchemaProperty[] Extract properties from a Zod object schema.
schemaZod object schema to extract from.
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>ZodSchemaProperty[] Array of property definitions.
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): string Get the type string for a schema, suitable for display.
schemaZod schema to get type string for.
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>string Human-readable type string.
(def: $ZodTypeDef): ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | undefined Unwrap nested schema types (optional, default, nullable, etc).
defZod type definition to unwrap.
$ZodTypeDefZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | undefined Inner schema if wrapped, undefined otherwise.
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): $ZodTypeDef Unwrap Zod wrappers (optional, default, nullable, pipe, transform) to get the base type definition.
schemaZod schema to unwrap
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>$ZodTypeDef the innermost non-wrapper type definition
(schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>): ZodObject<$ZodLooseShape, $strip> | null Unwrap a schema to find the inner ZodObject, or null if not an object schema.
Handles wrappers like z.strictObject({...}).default({...}).
schemaZod schema to unwrap
ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>ZodObject<$ZodLooseShape, $strip> | null the inner ZodObject or null
Set<string> Zod wrapper type names that zod_unwrap_def traverses through.
ZodFieldInfo Metadata extracted from a single field of a Zod object schema.
namestringbase_typestringrequiredbooleanhas_defaultbooleannullablebooleanZodSchemaProperty Property extracted from an object schema.
namestringtypestringdescriptionstringdefaultunknownaliasesArray<string>