Incorporate explanation from @colinhacks into message doc comment

colinhacks · Feb 4, 2025 · 82936b2 · 82936b2
1 parent c2750a0
commit 82936b2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/deno/lib/ZodError.ts b/deno/lib/ZodError.ts
@@ -285,7 +285,10 @@ export class ZodError<T = any> extends Error {
   }
 
   /**
-   * message returns the .issues field as a pretty-printed JSON string, NOT necessarily a human-readable message.
+   * message is a JSON.stringified issues array. This is an intentional decision
+   * to make the message property as informative as possible for logging, etc.
+   * You should use .issues to retrieve granular error information rather than
+   * JSON.parse(err.message).
    */
   override get message() {
     return JSON.stringify(this.issues, util.jsonStringifyReplacer, 2);

diff --git a/src/ZodError.ts b/src/ZodError.ts
@@ -285,7 +285,10 @@ export class ZodError<T = any> extends Error {
   }
 
   /**
-   * message returns the .issues field as a pretty-printed JSON string, NOT necessarily a human-readable message.
+   * message is a JSON.stringified issues array. This is an intentional decision
+   * to make the message property as informative as possible for logging, etc.
+   * You should use .issues to retrieve granular error information rather than
+   * JSON.parse(err.message).
    */
   override get message() {
     return JSON.stringify(this.issues, util.jsonStringifyReplacer, 2);