Getting Started

Installation

Install the plugin:

npm

npm add zod@latest
npm add -D unplugin-valype

yarn

yarn add zod@latest
yarn add -D unplugin-valype

pnpm

pnpm add zod@latest
pnpm add -D unplugin-valype

bun

bun add zod@latest
bun add -D unplugin-valype

zod's version should be 3.25.0 at least, but we recommend using zod v4 for the best experience, because valype generates zod v4 schema

Configuration

Add the plugin to your build tool configuration:

Vite

// vite.config.ts
import valype from 'unplugin-valype/vite'

export default defineConfig({
  plugins: [
    valype({ /* options */ }),
  ],
})

Rollup

// rollup.config.js
import valype from 'unplugin-valype/rollup'

export default {
  plugins: [
    valype({ /* options */ }),
  ],
}

Webpack

// webpack.config.js
module.exports = {
  plugins: [
    require('unplugin-valype/webpack')({ /* options */ })
  ]
}

Nuxt

// nuxt.config.js
export default defineNuxtConfig({
  modules: [
    ['unplugin-valype/nuxt', { /* options */ }],
  ],
})

Vue CLI

// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require('unplugin-valype/webpack')({ /* options */ }),
    ],
  },
}

esbuild

// esbuild.config.js
import { build } from 'esbuild'
import valype from 'unplugin-valype/esbuild'

build({
  plugins: [valype()],
})

Usage

1. Define your types (use .valype.ts extension):

// user.valype.ts
export interface User {
  name: string
  age: number
}

2. Use the generated validator:

import { validateUser } from './user.valype'

const issues = validateUser(data) // Returns ZodIssue[] or undefined
if (issues) {
  // Handle validation errors
}

For IDE/editor integration (VSCode extension, TypeScript plugin, etc.), see Editor & IDE Integration.

Validator Signature

unplugin-valype generates validators for types exported from *.valype.ts files:

export declare function validateSome(data: unknown): ZodIssue[] | undefined

• Returns undefined when validation passes
• Returns ZodIssue[] with error details when validation fails

Note: You typically don't need to use valype package directly, just use the generated validators.