zod: Cannot get error message from safeParse

This should work:

//or process.env
const parsedEnv = envSchema.safeParse(Bun.env);
//@ts-ignore
if(parsedEnv.success === false) { console.error(parsedEnv.error.message); process.exit(1); }

but it doesn’t. Instead i have to do these shenanigans:

const parsedEnv = envSchema.safeParse(Bun.env);
if(parsedEnv.success === false) { console.error(JSON.parse(parsedEnv.error.message)[0].message); process.exit(1); }

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Comments: 24 (2 by maintainers)

Most upvoted comments

@amany9000 There’s a quite easy workaround

So I believe this issue is still present and may have been misunderstood. I am not having any issues with the types, however the return type for parsed.error.message is wrong. It says I should receive a string, but I actually receive an array with one error object inside of it, like so:

[
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "number",
    "path": [],
    "message": "Expected string, received number"
  }
]

So, if you follow the documentation and provide parsed.error.message to the frontend, the frontend will show a JSON object. My current workaround is a function that grabs the error message and overrides the types like so:

export function getZodErrorMessage(error: z.ZodError): string {
  const message = error.message;
  const parsedMessage = JSON.parse(message) as Array<{ message: string }>;
  const zodError = parsedMessage[0];
  if (!zodError) throw Error("Zod is broken");
  return zodError.message;
}

However, I don’t think this should be necessary. It would be nice if this was fixed at some point in the future! Thanks 😄

I’m seeing the same issue. Here’s my code where I’m seeing it. I changed the variable names for security reasons but, it doesn’t change anything.

const envSchema = z.object({
  NODE_ENV: z.string().default("development"),

  // FOO
  FOO_API_KEY: z.string(),

  // BAR
  BAR_KEY: z.string(),
  BAR_REGION: z.string(),
})

const parsed = envSchema.safeParse(process.env)

if (!parsed.success) {
  console.error(
    `Error #%d: Failed Parsing .env file.
    Please ensure that it exists and is valid: `,
    JSON.stringify(parsed.error.format(), null, 4)
    //                    ^^^^^
  );
  process.exit(1);
} else {
 ...
}

VSCode Error for the underlined object:

Property ‘error’ does not exist on type ‘SafeParseReturnType<{ NODE_ENV?: string; FOO_API_KEY?: string; BAR_KEY?: string; BAR_REGION?: string; }, { NODE_ENV?: string; FOO_API_KEY?: string; BAR_KEY?: string; BAR_REGION?: string; }>’. Property ‘error’ does not exist on type ‘SafeParseSuccess<{ NODE_ENV?: string; FOO_API_KEY?: string; BAR_KEY?: string; BAR_REGION?: string; }>’.ts(2339)

It works if you do result.success === false. But !result.success doesn’t work…

No it isn’t

You need to enable strictNullChecks: true or strict: true. Once enabled you will not see this error. This is a requirement for Zod to properly type the results of parsing.

This has nothing to do with strict mode.

import { z } from 'zod'

const check = (env) => {
    const parsedEnv = z.string().safeParse(env);

    if(parsedEnv.success === false) { 
        console.error(parsedEnv.error.message); 
        process.exit(1); 
    } else {
        console.log('success!')
    }
}
check('1')
check(1)

when run

% node zod-repro.mjs

success!
[
  {
    "code": "invalid_type",
    "expected": "string",
    "received": "number",
    "path": [],
    "message": "Expected string, received number"
  }
]

with: zod@^3.22.4

The issue is resolved already?

Same, currenty facing this issue

@colinhacks @Creative-Difficulty, I’m facing the same issue and the return type for safeParse() is also incorrect.

So I believe this issue is still present and may have been misunderstood. I am not having any issues with the types, however the return type for parsed.error.message is wrong. […]

Per today’s code I think the type is actually technically correct (the best kind of correct):

https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/ZodError.ts#L286-L288

i.e. the output of the message getter is indeed a string, but a string of JSON rather than a human-readable message (as one might expect given the field’s name).

I’ve opened #3937 to start a discussion about possible resolutions (starting with just a comment clarifying what the field actually returns).

I am still encountering this error. I have set strict: true in my tsconfig.json.

Tried result.success === false as a workaround solution but the build is still failing and returns an error message from safeParse

Same here. image

Workaround: console.error((parsedObject as { error: Error }).error);

This is still an issue

I have same problem, image image