@surfjs/zod

Name: Surf
Author: Surf

Zod schema integration for Surf commands

@surfjs/zod#

Use Zod schemas for command parameters instead of the manual ParamSchema format. @surfjs/zod automatically converts Zod types to Surf's native schema format and provides full type inference in handlers.

bash

pnpm add @surfjs/zod zod

typescript

import { z } from 'zod'
import { createSurf } from '@surfjs/core'
import { defineZodCommand } from '@surfjs/zod'
 
const search = defineZodCommand({
  description: 'Search products',
  params: z.object({
    query:    z.string().describe('Search term'),
    limit:    z.number().int().min(1).max(100).default(10),
    inStock:  z.boolean().optional(),
  }),
  run({ query, limit, inStock }) {
    // All params are fully typed from the Zod schema
    // query   → string
    // limit   → number  (default 10)
    // inStock → boolean | undefined
    return db.products.search({ query, limit, inStock })
  },
})
 
const surf = await createSurf({
  name: 'My Store',
  commands: { search },
})

💡 Tip: Zod validators run automatically at request time — invalid params return a structured INVALID_PARAMS error with field-level messages before your handler is called.

The Zod schema is converted to Surf's ParamSchema at startup — no runtime Zod dependency is shipped to clients. Enum constraints, defaults, descriptions, and nested objects are all preserved in the manifest.

Edit this page on GitHub

PreviousClient WebSocket Next @surfjs/next