Document z.meta and z.describe

colinhacks · colinhacks · commit 947b4eb281cd · 2025-12-22T14:56:56.000-08:00
diff --git a/packages/docs/content/metadata.mdx b/packages/docs/content/metadata.mdx
@@ -135,9 +135,13 @@ const emailSchema = z.email().meta({
 </Tab>
 <Tab value="Zod Mini">
 ```ts
-// no equivalent
-  
- 
+const emailSchema = z.email().check(
+  z.meta({ 
+    id: "email_address",
+    title: "Email address",
+    description: "Please enter a valid email address",
+  })
+);
 ```
 </Tab>
 </Tabs>
@@ -181,11 +185,10 @@ emailSchema.meta({ description: "An email address" });
 </Tab>
 <Tab value="Zod Mini">
 ```ts
-// no equivalent
- 
- 
- 
- 
+const emailSchema = z.email().check(z.describe("An email address"));
+
+// equivalent to
+z.email().check(z.meta({ description: "An email address" }));
 ```
 </Tab>
 </Tabs>
diff --git a/packages/docs/content/packages/mini.mdx b/packages/docs/content/packages/mini.mdx
@@ -191,6 +191,10 @@ z.normalize();
 z.trim();
 z.toLowerCase();
 z.toUpperCase();
+
+// metadata (registers schema in z.globalRegistry)
+z.meta({ title: "...", description: "..." });
+z.describe("...");
 ```
 
 ### `.register()`
diff --git a/play.ts b/play.ts
@@ -3,3 +3,24 @@ import * as z from "zod";
 z.string().brand<"A", "in">();
 z.string().brand<"A", "out">();
 z.string().brand<"A", "inout">();
+
+const baseSchema = z.object({
+  value: z.number(),
+  allowsNegative: z.boolean(),
+  somethingElse: z.string(),
+});
+
+const refinement = z.refine<{ value: number; allowsNegative: boolean }>(({ value, allowsNegative }) => {
+  if (allowsNegative) {
+    return true;
+  }
+  return value >= 0;
+});
+
+const schema = baseSchema.check(refinement);
+
+const schemaB = baseSchema
+  .safeOmit({
+    somethingElse: true,
+  })
+  .check(refinement);
