https://github.com/intevel/h3-valibot
🤖 Schema validation for h3 using Valibot
https://github.com/intevel/h3-valibot
h3 nuxt schema schemas unjs valibot validation zod
Last synced: 6 months ago
JSON representation
🤖 Schema validation for h3 using Valibot
- Host: GitHub
- URL: https://github.com/intevel/h3-valibot
- Owner: Intevel
- License: mit
- Created: 2023-08-05T18:09:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T17:52:38.000Z (9 months ago)
- Last Synced: 2025-04-09T16:08:52.764Z (6 months ago)
- Topics: h3, nuxt, schema, schemas, unjs, valibot, validation, zod
- Language: TypeScript
- Homepage:
- Size: 382 KB
- Stars: 72
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# h3-valibot
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![License][license-src]][license-href]
Schema validation for h3 using Valibot 🤖
## Install
```sh
# Using npm
npm install h3-valibot
# Using yarn
yarn add h3-valibot
```
## Validation
```ts router.ts
import { useValidatedBody, v, vh } from 'h3-valibot'
import { createApp, createRouter, eventHandler } from 'h3';
import { email, minLength, string, objectAsync } from 'valibot';
export const app = createApp();
const LoginSchema = v.object({
email: vh.email,
password: v.pipe(v.string(), v.minLength(8)),
});
const router = createRouter();
app.use(router);
router.post("/login", eventHandler(async (event) => {
const body = await useValidatedBody(event, LoginSchema);
return body;
}),
);
```
### Safe Validation
```ts
// same as above
router.post("/login", eventHandler(async (event) => {
const body = await useSafeValidatedBody(event, LoginSchema);
if (!body.success) // do something
return body.output;
}),
);
```
## Utils available
`h3-valibot` provides a series of utils and their safe variants (don't throw an h3 error):
- `useValidatedBody`
- `useValidatedParams`
- `useValidatedQuery`
- `useSafeValidatedBody`
- `useSafeValidatedParams`
- `useSafeValidatedQuery`
Each one accepts an h3 `event`, a valibot `schema` and optionally a parser `config`.
### Helpers
It also provides a set of helpers via `vh` object, mainly related to string validation, particularly useful during the prototyping phase of any project. For production use we still suggest to create dedicated schemas with project-related error messages and fallbacks.
- `boolAsString`
- `checkboxAsString`
- `dateAsString`
- `intAsString`
- `numAsString`
- `email`
- `uuid`
For more details or examples please refer to their JSdocs or [source code](/src/core/schemas.ts).
## Errors
`h3-valibot` throws an `ValiError` when the validation fails:
Example
```json
{
"statusCode": 400,
"statusMessage": "Bad Request",
"stack": [],
"data": {
"issues": [
{
"validation": "email",
"origin": "value",
"message": "Invalid email",
"input": "github@conner-bachmande",
"path": [
{
"schema": "object",
"input": {
"email": "github@conner-bachmande",
"password": "12345678"
},
"key": "email",
"value": "github@conner-bachmande"
}
],
"reason": "string"
}
],
"name": "ValiError"
}
}
```
## Nuxt auto-imports
This library supports Nuxt's auto-imports, just add it in your `nuxt.config.ts`:
```ts
export default defineNuxtConfig({
modules: [
// ...
'h3-valibot/nuxt',
],
})
```
## License
Published under MIT - Made with ❤️ by Conner Bachmann
[npm-version-src]: https://img.shields.io/npm/v/h3-valibot/latest.svg
[npm-version-href]: https://npmjs.com/package/h3-valibot
[npm-downloads-src]: https://img.shields.io/npm/dt/h3-valibot.svg
[npm-downloads-href]: https://npmjs.com/package/h3-valibot
[github-actions-ci-src]: https://github.com/intevel/h3-valibot/actions/workflows/ci.yml/badge.svg
[github-actions-ci-href]: https://github.com/intevel/h3-valibot/actions?query=workflow%3Aci
[license-src]: https://img.shields.io/npm/l/h3-valibot.svg
[license-href]: https://npmjs.com/package/h3-valibot