gem-hunter

h3-zod

Important

Starting with h3 version 1.8.0, built-in runtime + type-safe request utilities are included, so you might not need this module.

Install

npm install zod h3-zod

Usage

import { useSafeValidatedBody, useSafeValidatedQuery, zh } from 'h3-zod'

// Or

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
  }
})

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()
  })
})

export default defineEventHandler(async (event) => {
  const body = await zh.useValidatedBody(event, {
    optional: z.string().optional(),
    required: z.boolean()
  })
})

Helper Zod Schemas

zh.boolAsString

zh.checkboxAsString

zh.intAsString

zh.numAsString

Usage

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

License