Allow Custom Errors on any value?

Any reason not to allow defining the last argument for any value as an error message to allow overriding the error message for that property easily? The current method is not really ideal, especially when you have many string props but need different errors.

A couple nice ways to handle it:

Allow Last Param to be Error Message

Would also accept a custom error that it would throw instead of ZodError (similar to Joi)

const TestSchema = z.object({
	three: z.literal('hi').optional(),
	one: z.number(),
	two: z.literal(3, 'that isnt 3 dummy'),
	four: z.string('string not whatever you gave!'),
	five: z.date()
})

Add a .error() option like Joi

const TestSchema = z.object({
	three: z.literal('hi').optional(),
	one: z.number(),
	two: z.literal(3).error(new Error('that isnt 3 dummy')),
	four: z.string().optional().error(new Error('string not whatever you gave!')),
	five: z.date()
})

---

For the VSCode extension I am working on, these styles add the benefit that jsdoc can be used to transfer over error messaging easily:

[colinhacks]

This is on the roadmap. Though it’ll likely be an object instead of a string to leave room for future API additions.

z.string({ message: "That's not a string!" });

[amankkg]

What about yup#setLocale API? It seems to be easier to handle global translations for both primitives and their methods