Any way to print the provided value when zod parse fails?

[jamischarles]

Hi folks! I'm using Zod to validate API response shape in my node scripts.

Is there currently any built-in way to show a jest-style diff that shows expected value vs received value?

All I'm finding currently is ways to print the error message like "your input is too low".

I'm looking for:
expected: number
provided: 'hello'

Anything like this already exist in Zod?

Thanks!

[JacobWeisenburger]

I think what you want is .safeParse

const schema = z.string()
const result = schema.safeParse( 123 )
!result.success && console.log( result.error.issues )
// [
//     {
//       code: "invalid_type",
//       expected: "string",
//       received: "number",
//       path: [],
//       message: "Expected string, received number"
//     }
// ]

Let me know if you have any questions.

[jamischarles]

Thank you @JacobWeisenburger for the reply.

Will this give me access to the input value?

ie:
stringSchema.safeParse(12);
// => { success: false; error: ZodError }
// Q: Any way to get data in the error scenario ^?

stringSchema.safeParse("billie");
// => { success: true; data: 'billie' }

What I'm really after is the ability to see data when there's an error.

[JacobWeisenburger]

I don't think there is anything built into zod that does that. However, I have made this:
https://gist.github.com/JacobWeisenburger/d5dbb4d5bcbb287b7661061a78536423

[bakert]

Looks like this was added to zod for v4 https://zod.dev/error-customization?id=include-input-in-issues

z.string().parse(12, {
  reportInput: true
})
 
// ZodError: [
//   {
//     "expected": "string",
//     "code": "invalid_type",
//     "input": 12, // 👀
//     "path": [],
//     "message": "Invalid input: expected string, received number"
//   }
// ]

[wegry]

This should be marked as the answer. Works like a charm.

[samal-rasmussen]

Any way to do this globally? Having to add this to every single schema is tedious.

[bakert]

Seems like only monkey patching – #5298 (comment)