Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wobsoriano/h3-zod
TypeScript-first schema validation for h3 and Nuxt applications
https://github.com/wobsoriano/h3-zod
nuxt schema-validation typescript vue zod
Last synced: 29 days ago
JSON representation
TypeScript-first schema validation for h3 and Nuxt applications
- Host: GitHub
- URL: https://github.com/wobsoriano/h3-zod
- Owner: wobsoriano
- License: mit
- Created: 2022-06-28T02:35:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-24T03:43:07.000Z (6 months ago)
- Last Synced: 2024-10-02T08:52:05.188Z (about 1 month ago)
- Topics: nuxt, schema-validation, typescript, vue, zod
- Language: TypeScript
- Homepage:
- Size: 334 KB
- Stars: 150
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# h3-zod
[](https://www.npmjs.com/package/h3-zod)  
Validate [h3](https://github.com/unjs/h3) and Nuxt requests with [zod](https://github.com/colinhacks/zod).
> [!IMPORTANT]
> Starting with h3 version 1.8.0, built-in [runtime + type-safe request utilities](https://unjs.io/blog/2023-08-15-h3-towards-the-edge-of-the-web#runtime-type-safe-request-utils) are included, so you might not need this module.
## Install
```bash
npm install zod h3-zod
```
## Usage
Import it like:
```ts
import { zh } from 'h3-zod';
// Or
import { useSafeValidatedQuery, useSafeValidatedBody } from 'h3-zod';
```
Helpers that don't throw when parsing fails:
```ts
export default defineEventHandler(async (event) => {
const query = await zh.useSafeValidatedQuery(event, z.object({
required: z.string()
}))
const body = await zh.useSafeValidatedBody(event, z.object({
optional: z.string().optional(),
required: z.boolean()
}))
const params = await zh.useSafeValidatedParams(event, {
id: z.number()
})
if (!params.success) {
// params.error
}
})
```
Helpers that throw error 400 when parsing fails:
```ts
export default defineEventHandler(async (event) => {
const query = await zh.useValidatedQuery(event, z.object({
required: z.string()
}))
const body = await zh.useValidatedBody(event, z.object({
optional: z.string().optional(),
required: z.boolean()
}))
const params = await zh.useValidatedParams(event, {
id: z.number()
})
})
```
You can also pass an object schema:
```ts
export default defineEventHandler(async (event) => {
const body = await zh.useValidatedBody(event, {
optional: z.string().optional(),
required: z.boolean()
})
})
```
## Helper Zod Schemas
#### zh.boolAsString
- `"true"` → `true`
- `"false"` → `false`
- `"notboolean"` → throws `ZodError`
#### zh.checkboxAsString
- `"on"` → `true`
- `undefined` → `false`
- `"anythingbuton"` → throws `ZodError`
#### zh.intAsString
- `"3"` → `3`
- `"3.14"` → throws `ZodError`
- `"notanumber"` → throws `ZodError`
#### zh.numAsString
- `"3"` → `3`
- `"3.14"` → `3.14`
- `"notanumber"` → throws `ZodError`
### Usage
```ts
const Schema = z.object({
isAdmin: zh.boolAsString,
agreedToTerms: zh.checkboxAsString,
age: zh.intAsString,
cost: zh.numAsString,
});
const parsed = Schema.parse({
isAdmin: 'true',
agreedToTerms: 'on',
age: '38',
cost: '10.99'
});
console.log(parsed)
// {
// isAdmin: true,
// agreedToTerms: true,
// age: 38,
// cost: 10.99
// }
```
## Related
- [h3-typebox](https://github.com/kevinmarrec/h3-typebox)
## License
MIT