add name() to define displayName

colinhacks · Apr 28, 2022 · dc9c438 · dc9c438
1 parent 8688e9f
commit dc9c438
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -96,6 +96,7 @@ These docs have been translated into [Chinese](./README_ZH.md).
   - [.and](#and)
   - [.describe](#describe)
   - [.localize](#localize)
+  - [.name](#name)
 - [Guides and concepts](#guides-and-concepts)
   - [Type inference](#type-inference)
   - [Writing generic functions](#writing-generic-functions)
@@ -1696,6 +1697,14 @@ const nullishString = z.string().nullish(); // string | null | undefined
 z.string().optional().nullable();
 ```
 
+### `.describe`
+
+A schema method that adds a description to the schema for documentation purpose.
+
+```ts
+const description = z.string().describe('usefull description').description; // string
+```
+
 ### `.localize`
 
 A schema method that defines that the schema should be translated.
@@ -1704,12 +1713,12 @@ A schema method that defines that the schema should be translated.
 const isLocalized = z.string().localize(true).localized; // boolean
 ```
 
-### `.describe`
+### `.name`
 
-A schema method that adds a description to the schema for documentation purpose.
+A schema method that defines the displayName.
 
 ```ts
-const description = z.string().describe('usefull description').description; // string
+const name = z.string().name(true).displayName;
 ```
 
 ### `.array`

diff --git a/deno/lib/__tests__/name.test.ts b/deno/lib/__tests__/name.test.ts
@@ -0,0 +1,11 @@
+// @ts-ignore TS6133
+import { expect } from "https://deno.land/x/expect@v0.2.6/mod.ts";
+const test = Deno.test;
+
+import * as z from "../index.ts";
+
+test("name", () => {
+  const displayName = "myDisplayName";
+  const schema = z.string().name(displayName);
+  expect(schema.displayName).toEqual(displayName);
+});
diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -59,6 +59,7 @@ export interface ZodTypeDef {
   errorMap?: ZodErrorMap;
   description?: string;
   localized?: boolean;
+  displayName?: string;
 }
 
 class ParseInputLazyPath implements ParseInput {
@@ -106,12 +107,14 @@ type RawCreateParams =
       required_error?: string;
       description?: string;
       localized?: boolean;
+      displayName?: string;
     }
   | undefined;
 type ProcessedCreateParams = {
   errorMap?: ZodErrorMap;
   description?: string;
   localized?: boolean;
+  displayName?: string;
 };
 function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
   if (!params) return {};
@@ -121,6 +124,7 @@ function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
     required_error,
     description,
     localized,
+    displayName,
   } = params;
   if (errorMap && (invalid_type_error || required_error)) {
     throw new Error(
@@ -136,7 +140,7 @@ function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
       return { message: params.invalid_type_error };
     return { message: ctx.defaultError };
   };
-  return { errorMap: customMap, description, localized };
+  return { errorMap: customMap, description, localized, displayName };
 }
 
 export type SafeParseSuccess<Output> = { success: true; data: Output };
@@ -164,6 +168,10 @@ export abstract class ZodType<
     return this._def.localized;
   }
 
+  get displayName() {
+    return this._def.displayName;
+  }
+
   abstract _parse(input: ParseInput): ParseReturnType<Output>;
 
   _getType(input: ParseInput): string {
@@ -391,6 +399,7 @@ export abstract class ZodType<
     this.isNullable = this.isNullable.bind(this);
     this.isOptional = this.isOptional.bind(this);
     this.localize = this.localize.bind(this);
+    this.name = this.name.bind(this);
   }
 
   optional(): ZodOptional<this> {
@@ -455,6 +464,14 @@ export abstract class ZodType<
     });
   }
 
+  name(displayName: string): this {
+    const This = (this as any).constructor;
+    return new This({
+      ...this._def,
+      displayName,
+    });
+  }
+
   isOptional(): boolean {
     return this.safeParse(undefined).success;
   }

diff --git a/src/__tests__/name.test.ts b/src/__tests__/name.test.ts
@@ -0,0 +1,10 @@
+// @ts-ignore TS6133
+import { expect, test } from "@jest/globals";
+
+import * as z from "../index";
+
+test("name", () => {
+  const displayName = "myDisplayName";
+  const schema = z.string().name(displayName);
+  expect(schema.displayName).toEqual(displayName);
+});
diff --git a/src/types.ts b/src/types.ts
@@ -59,6 +59,7 @@ export interface ZodTypeDef {
   errorMap?: ZodErrorMap;
   description?: string;
   localized?: boolean;
+  displayName?: string;
 }
 
 class ParseInputLazyPath implements ParseInput {
@@ -106,12 +107,14 @@ type RawCreateParams =
       required_error?: string;
       description?: string;
       localized?: boolean;
+      displayName?: string;
     }
   | undefined;
 type ProcessedCreateParams = {
   errorMap?: ZodErrorMap;
   description?: string;
   localized?: boolean;
+  displayName?: string;
 };
 function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
   if (!params) return {};
@@ -121,6 +124,7 @@ function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
     required_error,
     description,
     localized,
+    displayName,
   } = params;
   if (errorMap && (invalid_type_error || required_error)) {
     throw new Error(
@@ -136,7 +140,7 @@ function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
       return { message: params.invalid_type_error };
     return { message: ctx.defaultError };
   };
-  return { errorMap: customMap, description, localized };
+  return { errorMap: customMap, description, localized, displayName };
 }
 
 export type SafeParseSuccess<Output> = { success: true; data: Output };
@@ -164,6 +168,10 @@ export abstract class ZodType<
     return this._def.localized;
   }
 
+  get displayName() {
+    return this._def.displayName;
+  }
+
   abstract _parse(input: ParseInput): ParseReturnType<Output>;
 
   _getType(input: ParseInput): string {
@@ -391,6 +399,7 @@ export abstract class ZodType<
     this.isNullable = this.isNullable.bind(this);
     this.isOptional = this.isOptional.bind(this);
     this.localize = this.localize.bind(this);
+    this.name = this.name.bind(this);
   }
 
   optional(): ZodOptional<this> {
@@ -455,6 +464,14 @@ export abstract class ZodType<
     });
   }
 
+  name(displayName: string): this {
+    const This = (this as any).constructor;
+    return new This({
+      ...this._def,
+      displayName,
+    });
+  }
+
   isOptional(): boolean {
     return this.safeParse(undefined).success;
   }