Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roziscoding/zod-express-guard
Small package intended to use zod to make express request type-safe.
https://github.com/roziscoding/zod-express-guard
express hacktoberfest nodejs typescript validation
Last synced: about 2 months ago
JSON representation
Small package intended to use zod to make express request type-safe.
- Host: GitHub
- URL: https://github.com/roziscoding/zod-express-guard
- Owner: roziscoding
- License: gpl-3.0
- Created: 2020-12-06T23:16:27.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T13:40:14.000Z (12 months ago)
- Last Synced: 2024-07-26T04:33:19.935Z (about 2 months ago)
- Topics: express, hacktoberfest, nodejs, typescript, validation
- Language: TypeScript
- Homepage:
- Size: 1.09 MB
- Stars: 23
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-zod - `zod-express-guard` - Small package intended to use zod to make express request type-safe. (APIs and Servers)
README
# zod-express-guard
Small package intended to use zod to make express request type-safe.
---
[](https://github.com/roziscoding/zod-express-guard/actions?query=workflow%3A%22Node.js+CI%22) [](https://www.npmjs.com/package/zod-express-guard) []()
[]()
[]() []() []()
---
## Installation
Just install with your favorite package manager:
`npm i zod-express-guard`
Zod, Express and @types/express are peer dependencies, so you can change versions without having to
wait for me to update this library. Newer versions of npm resolve these by default, but you can do
it manually like this:
`npm i -D @types/express && npm i express zod`
## Usage
This library exposes four validation functions, and three of them are shortcuts that end up calling
the first one.
All functions support async middlewares and will catch async errors.
### validate
This is the main function. It receives an object with the Zod schemas for what you want to validate,
together with the middleware you want to guard. If validation passes, your middleware will be called
with type-safe `req` properties. If validation fails, `next` will be called containg and instance of
`ZodError`
**Example**:
```typescript
// routes/login.ts
import z from 'zod'
import { validate } from 'zod-express-guard'
export default validate(
{
body: z.object({
login: z.string().nonempty(),
password: z.string().nonempty()
})
},
(req, res) => {
// req.body has the type { login: string, password: string }
// req.query and req.params have type unknown, since they were not validated
res.status(200).json({ message: 'Validation passed' })
}
)
```
You can pass up to three properties to the first parameter: `body`, `query` and `params`, each one
validates its respective property inside `req`
### `validateBody`, `validateQuery` and `validateParams`
These three functions serve as shortcuts when you only want to validate a single property inside
`req`. This is useful for our login middleware in the previous example:
```typescript
// routes/login.ts
import z from 'zod'
import { validateBody } from 'zod-express-guard'
export default validateBody(
z.object({
login: z.string().nonempty(),
password: z.string().nonempty()
}),
(req, res) => {
// req.body has the type { login: string, password: string }
// req.query and req.params have type unknown, since they were not validated
res.status(200).json({ message: 'Validation passed' })
}
)
```
`validateQuery` and `validateParams` work similarly, but for `req.query` and `req.params`,
respectively.
Note that, when using a shortcut function, only one of the three properties will be validated and
made acessible, and the other two will have type `unknown`
## Contributing
### Environment setup
Clone this and run `npm install` on the root.
### Making changes
Please make sure you modify the tests to reflect any changes you add.
Use `npx gitmoji -c` to commit, and follow existing commit patterns
### Running tests
Simply run `npm test` after running `npm install`.
The `package.json` already specifies a `pretest` script that will run a clean build before testing.