zod-validation-error
Wrap zod validation errors in user-friendly readable messages.
Features
- User-friendly readable messages, configurable via options;
- Maintain original errors under
error.details; - Extensive tests.
Installation
npm install zod-validation-error
Requirements
- Node.js v.14+
Quick start
// create zod schema
const zodSchema = zod.object({
id: zod.number().int().positive(),
email: zod.string().email(),
});
// parse some invalid value
try {
zodSchema.parse({
id: 1,
email: 'foobar', // note: invalid email
});
} catch (err) {
const validationError = fromZodError(err);
// the error now is readable by the user
// you may print it to console
// or return it via an API
console.log(validationError);
}
Motivation
Zod errors are difficult to consume for the end-user. This library wraps Zod validation errors in user-friendly readable messages that can be exposed to the outer world, while maintaining the original errors in an array for dev use.
Example
Input (from Zod)
[
{
"code": "too_small",
"inclusive": false,
"message": "Number must be greater than 0",
"minimum": 0,
"path": ["id"],
"type": "number"
},
{
"code": "invalid_string",
"message": "Invalid email",
"path": ["email"],
"validation": "email"
}
]
Output
Validation error: Number must be greater than 0 at "id"; Invalid email at "email"
Contribute
Source code contributions are most welcome. Please open a PR, ensure the linter is satisfied and all tests pass.
We are hiring
Causaly is building the world's largest biomedical knowledge platform, using technologies such as TypeScript, React and Node.js. Find out more about our openings at https://apply.workable.com/causaly/.
License
MIT
104 Jan 4, 2023
339 Dec 28, 2022
31 Jul 27, 2022
3 Jul 18, 2022
6 Jul 12, 2022
5 Jun 15, 2022
8 Dec 28, 2022
24 Dec 28, 2022
19 Dec 19, 2022
212 Dec 27, 2022
172 Dec 22, 2022
9 Nov 1, 2021
955 Dec 3, 2022
28 Oct 28, 2022
47 Dec 22, 2022
1 Jan 20, 2022
1.5k Jan 8, 2023
5 Jul 28, 2022
14 Dec 19, 2022