Add describe

README.md

@@ -11,10 +11,14 @@
 
 </p>
 <p align="center">
-⭐️ smash that star button ⭐️
+by [@colinhacks](https://twitter.com/colinhacks)
 </p>
 
-> Like typesafety? Check out [tRPC](https://trpc.io) — a better way to build end-to-end typesafe APIs without GraphQL or code generation — just TypeScript.
+> Hi! Colin here, creator of Zod. I hope you find it easy to use and powerful enough for all your use cases. If you have any issues or suggestions, please  [open an issue](https://github.com/colinhacks/zod/issues/new)! 
+>
+> If you like typesafety, check out my other library [tRPC](https://trpc.io). It works in concert with Zod to provide a seamless way to build end-to-end typesafe APIs without GraphQL or code generation — just TypeScript.
+>
+> Colin (AKA [@colinhacks](https://twitter.com/colinhacks))
 
 <br/>
 

deno/lib/__tests__/description.test.ts

@@ -0,0 +1,11 @@
+// @ts-ignore TS6133
+import { expect } from "https://deno.land/x/[email protected]/mod.ts";
+const test = Deno.test;
+
+import * as z from "../index.ts";
+
+test("description", () => {
+  const schema: any = z.string();
+  const DESC = "asdlfkjasdf";
+  expect(schema.describe(DESC).description).toEqual(DESC);
+});

deno/lib/types.ts

@@ -54,6 +54,7 @@ export type { TypeOf as infer };
 export type CustomErrorParams = Partial<util.Omit<ZodCustomIssue, "code">>;
 export interface ZodTypeDef {
   errorMap?: ZodErrorMap;
+  description?: string;
 }
 
 const handleResult = <Input, Output>(
@@ -78,9 +79,10 @@ type RawCreateParams =
       errorMap?: ZodErrorMap;
       invalid_type_error?: string;
       required_error?: string;
+      description?: string;
     }
   | undefined;
-type ProcessedCreateParams = { errorMap?: ZodErrorMap };
+type ProcessedCreateParams = { errorMap?: ZodErrorMap; description?: string };
 function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
   if (!params) return {};
   if (params.errorMap && (params.invalid_type_error || params.required_error)) {
@@ -110,6 +112,10 @@ export abstract class ZodType<
   readonly _input!: Input;
   readonly _def!: Def;
 
+  get description() {
+    return this._def.description;
+  }
+
   abstract _parse(input: ParseInput): ParseReturnType<Output>;
 
   _processInputParams(
@@ -336,6 +342,14 @@ export abstract class ZodType<
     }) as any;
   }
 
+  describe(description: string): this {
+    const This = (this as any).constructor;
+    return new This({
+      ...this._def,
+      description,
+    });
+  }
+
   isOptional(): boolean {
     return this.safeParse(undefined).success;
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod",
-  "version": "3.11.2",
+  "version": "3.11.4",
   "description": "TypeScript-first schema declaration and validation library with static type inference",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

src/__tests__/description.test.ts

@@ -0,0 +1,10 @@
+// @ts-ignore TS6133
+import { expect, test } from "@jest/globals";
+
+import * as z from "../index";
+
+test("description", () => {
+  const schema: any = z.string();
+  const DESC = "asdlfkjasdf";
+  expect(schema.describe(DESC).description).toEqual(DESC);
+});

src/types.ts

@@ -54,6 +54,7 @@ export type { TypeOf as infer };
 export type CustomErrorParams = Partial<util.Omit<ZodCustomIssue, "code">>;
 export interface ZodTypeDef {
   errorMap?: ZodErrorMap;
+  description?: string;
 }
 
 const handleResult = <Input, Output>(
@@ -78,9 +79,10 @@ type RawCreateParams =
       errorMap?: ZodErrorMap;
       invalid_type_error?: string;
       required_error?: string;
+      description?: string;
     }
   | undefined;
-type ProcessedCreateParams = { errorMap?: ZodErrorMap };
+type ProcessedCreateParams = { errorMap?: ZodErrorMap; description?: string };
 function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
   if (!params) return {};
   if (params.errorMap && (params.invalid_type_error || params.required_error)) {
@@ -110,6 +112,10 @@ export abstract class ZodType<
   readonly _input!: Input;
   readonly _def!: Def;
 
+  get description() {
+    return this._def.description;
+  }
+
   abstract _parse(input: ParseInput): ParseReturnType<Output>;
 
   _processInputParams(
@@ -336,6 +342,14 @@ export abstract class ZodType<
     }) as any;
   }
 
+  describe(description: string): this {
+    const This = (this as any).constructor;
+    return new This({
+      ...this._def,
+      description,
+    });
+  }
+
   isOptional(): boolean {
     return this.safeParse(undefined).success;
   }