Add comment to message getter noting that it returns JSON

colinhacks · Jan 7, 2025 · c2750a0 · c2750a0
1 parent f7ad261
commit c2750a0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/deno/lib/ZodError.ts b/deno/lib/ZodError.ts
@@ -283,6 +283,10 @@ export class ZodError<T = any> extends Error {
   override toString() {
     return this.message;
   }
+
+  /**
+   * message returns the .issues field as a pretty-printed JSON string, NOT necessarily a human-readable message.
+   */
   override get message() {
     return JSON.stringify(this.issues, util.jsonStringifyReplacer, 2);
   }

diff --git a/src/ZodError.ts b/src/ZodError.ts
@@ -283,6 +283,10 @@ export class ZodError<T = any> extends Error {
   override toString() {
     return this.message;
   }
+
+  /**
+   * message returns the .issues field as a pretty-printed JSON string, NOT necessarily a human-readable message.
+   */
   override get message() {
     return JSON.stringify(this.issues, util.jsonStringifyReplacer, 2);
   }