feat: trim method for ZodString (#681)

* feat: trim method for ZodString * Update implementation * Add documentation * Fix conflict Co-authored-by: Colin McDonnell <colinmcd@alum.mit.edu>
colinhacks · May 22, 2022 · 4459e75 · 4459e75
1 parent ff5de24
commit 4459e75
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -421,6 +421,9 @@ z.string().uuid();
 z.string().cuid();
 z.string().regex(regex);
 
+// trim whitespace
+z.string().trim();
+
 // deprecated, equivalent to .min(1)
 z.string().nonempty();
 

diff --git a/deno/lib/__tests__/string.test.ts b/deno/lib/__tests__/string.test.ts
@@ -170,3 +170,11 @@ test("min max getters", () => {
   expect(z.string().max(5).maxLength).toEqual(5);
   expect(z.string().max(5).max(1).maxLength).toEqual(1);
 });
+
+test("trim", () => {
+  expect(z.string().trim().min(2).parse(" 12 ")).toEqual("12");
+
+  // ordering of methods is respected
+  expect(z.string().min(2).trim().parse(" 1 ")).toEqual("1");
+  expect(() => z.string().trim().min(2).parse(" 1 ")).toThrow();
+});
diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -452,7 +452,8 @@ type ZodStringCheck =
   | { kind: "url"; message?: string }
   | { kind: "uuid"; message?: string }
   | { kind: "cuid"; message?: string }
-  | { kind: "regex"; regex: RegExp; message?: string };
+  | { kind: "regex"; regex: RegExp; message?: string }
+  | { kind: "trim"; message?: string };
 
 export interface ZodStringDef extends ZodTypeDef {
   checks: ZodStringCheck[];
@@ -569,6 +570,10 @@ export class ZodString extends ZodType<string, ZodStringDef> {
           });
           status.dirty();
         }
+      } else if (check.kind === "trim") {
+        input.data = input.data.trim();
+      } else {
+        util.assertNever(check);
       }
     }
 
@@ -640,6 +645,12 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   nonempty = (message?: errorUtil.ErrMessage) =>
     this.min(1, errorUtil.errToObj(message));
 
+  trim = () =>
+    new ZodString({
+      ...this._def,
+      checks: [...this._def.checks, { kind: "trim" }],
+    });
+
   get isEmail() {
     return !!this._def.checks.find((ch) => ch.kind === "email");
   }
@@ -674,6 +685,7 @@ export class ZodString extends ZodType<string, ZodStringDef> {
     });
     return max;
   }
+
   static create = (params?: RawCreateParams): ZodString => {
     return new ZodString({
       checks: [],

diff --git a/src/__tests__/string.test.ts b/src/__tests__/string.test.ts
@@ -169,3 +169,11 @@ test("min max getters", () => {
   expect(z.string().max(5).maxLength).toEqual(5);
   expect(z.string().max(5).max(1).maxLength).toEqual(1);
 });
+
+test("trim", () => {
+  expect(z.string().trim().min(2).parse(" 12 ")).toEqual("12");
+
+  // ordering of methods is respected
+  expect(z.string().min(2).trim().parse(" 1 ")).toEqual("1");
+  expect(() => z.string().trim().min(2).parse(" 1 ")).toThrow();
+});
diff --git a/src/types.ts b/src/types.ts
@@ -452,7 +452,8 @@ type ZodStringCheck =
   | { kind: "url"; message?: string }
   | { kind: "uuid"; message?: string }
   | { kind: "cuid"; message?: string }
-  | { kind: "regex"; regex: RegExp; message?: string };
+  | { kind: "regex"; regex: RegExp; message?: string }
+  | { kind: "trim"; message?: string };
 
 export interface ZodStringDef extends ZodTypeDef {
   checks: ZodStringCheck[];
@@ -569,6 +570,10 @@ export class ZodString extends ZodType<string, ZodStringDef> {
           });
           status.dirty();
         }
+      } else if (check.kind === "trim") {
+        input.data = input.data.trim();
+      } else {
+        util.assertNever(check);
       }
     }
 
@@ -640,6 +645,12 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   nonempty = (message?: errorUtil.ErrMessage) =>
     this.min(1, errorUtil.errToObj(message));
 
+  trim = () =>
+    new ZodString({
+      ...this._def,
+      checks: [...this._def.checks, { kind: "trim" }],
+    });
+
   get isEmail() {
     return !!this._def.checks.find((ch) => ch.kind === "email");
   }
@@ -674,6 +685,7 @@ export class ZodString extends ZodType<string, ZodStringDef> {
     });
     return max;
   }
+
   static create = (params?: RawCreateParams): ZodString => {
     return new ZodString({
       checks: [],