This module provides a powerful Express middleware for input validation and parsing using Zod. It simplifies the process of ensuring that your route handlers receive correctly typed and validated data, while also handling errors in a consistent manner.
- Type Safety: Leverages Zod to enforce input types, ensuring that your handlers work with data that adheres to your specifications.
- Error Handling: Includes a mechanism to handle unexpected errors gracefully, as well as to report parsing errors back to the client.
To use this middleware, ensure you have Express and Zod installed in your project. If not, you can install them using npm:
npm install @shaharke/zod-expressFor a route that requires input validation:
import express from 'express';
import { zodx } from '@shaharke/zod-express';
import { z } from 'zod';
const app = express();
app.use(express.json()); // for parsing application/json
const InputSchema = z.object({
foo: z.string(),
});
type Input = z.infer<typeof InputSchema>;
app.post('/your-route', zodx(async (input: Input) => {
// Your logic here, with input being already validated
return { message: `Received: ${input.foo}` };
}, InputSchema));
app.listen(3000, () => console.log('Server running on port 3000'));You can also use a custom validation function to handle more complex validation logic:
import express from 'express';
import { zodx } from '@shaharke/zod-express';
import { z } from 'zod';
const app = express();
app.use(express.json()); // for parsing application/json
const InputSchema = z.object({
foo: z.string(),
});
type Input = z.infer<typeof InputSchema>;
const customValidation = (req: Request) => {
return InputSchema.safeParse(req.body);
};
app.post('/your-route', zodx(async (input: Input) => {
return { message: `Received: ${input.foo}` };
}, customValidation));For a simple route that doesn't require input parsing:
import express from 'express';
import { zodx } from '@shaharke/zod-express';
import { z } from 'zod';
const app = express();
app.use(express.json()); // for parsing application/json
app.post('/your-route', zodx(async () => {
// Your logic here
return { message: 'Success!' };
}));
app.listen(3000, () => console.log('Server running on port 3000'));To handle unexpected errors, you can pass an optional error handler to the middleware:
import { Request, Response } from 'express';
const errorHandler = (error: Error, req: Request, res: Response) => {
console.error('Unexpected error:', error);
res.status(500).send('An unexpected error occurred');
};
// Use it as the third argument in zodx
app.post('/your-route', zodx(handler, schema, errorHandler));You can configure a global error handler for all routes that use zod-express by calling
the config function:
import { config, zodx } from '@shaharke/zod-express';
config({
errorHandler: (error: Error, req: Request, res: Response) => {
console.error('Unexpected error:', error);
res.status(503).send('An unexpected error occurred');
},
});
app.post('/your-route', zodx(handler, schema));Setting a global error handler does not prevent you from passing a custom error handler to a specific route as described above.
You can also scope the default error handler to a specific middleware factory instance:
import { config } from '@shaharke/zod-express';
const zodx = factory({
errorHandler: (error: Error, req: Request, res: Response) => {
console.error('Unexpected error:', error);
res.status(503).send('An unexpected error occurred');
},
});
app.post('/your-route', zodx(handler, schema));