honojs-middleware/packages/zod-validator
Yusuke Wada 7a401b0850
chore: use the latest eslint and `@hono/eslint-config` (#904)
* chore: use the latest eslint and `@hono/eslint-config`

* update codes
2024-12-25 18:08:43 +09:00
..
src chore: use the latest eslint and `@hono/eslint-config` (#904) 2024-12-25 18:08:43 +09:00
test chore: use the latest eslint and `@hono/eslint-config` (#904) 2024-12-25 18:08:43 +09:00
CHANGELOG.md Version Packages (#885) 2024-12-13 17:01:35 +09:00
README.md docs(zod-validator): add usage docs for `zErrValidator` (#900) 2024-12-25 10:32:07 +09:00
package.cjs.json fix(zod-validator): fix export for esm module (#431) 2024-03-26 09:03:48 +09:00
package.json Version Packages (#885) 2024-12-13 17:01:35 +09:00
tsconfig.cjs.json feat: introduce zod-validator (#16) 2023-01-02 00:03:44 +09:00
tsconfig.esm.json feat: introduce zod-validator (#16) 2023-01-02 00:03:44 +09:00
tsconfig.json feat: introduce zod-validator (#16) 2023-01-02 00:03:44 +09:00
vitest.config.ts fix(zod-validator): fix export for esm module (#431) 2024-03-26 09:03:48 +09:00

README.md

Zod validator middleware for Hono

The validator middleware using Zod for Hono applications. You can write a schema with Zod and validate the incoming values.

Usage

import { z } from 'zod'
import { zValidator } from '@hono/zod-validator'

const schema = z.object({
  name: z.string(),
  age: z.number(),
})

app.post('/author', zValidator('json', schema), (c) => {
  const data = c.req.valid('json')
  return c.json({
    success: true,
    message: `${data.name} is ${data.age}`,
  })
})

Hook:

app.post(
  '/post',
  zValidator('json', schema, (result, c) => {
    if (!result.success) {
      return c.text('Invalid!', 400)
    }
  })
  //...
)

Throw Error:

throw a zod validate error instead of directly returning an error response.

// file: validator-wrapper.ts
import { ZodSchema } from "zod";
import type { ValidationTargets } from "hono";
import { zValidator as zv } from "@hono/zod-validator";

export const zValidator = (target: keyof ValidationTargets,  schema: ZodSchema) => 
zv(target, schema, (result, c) => {
  if (!result.success) {
    throw new HTTPException(400, { cause: result.error });
  }
})

// usage
import { zValidator } from './validator-wrapper'
app.post(
  '/post',
  zValidator('json', schema)
  //...
)

Author

Yusuke Wada https://github.com/yusukebe

License

MIT