@typeschema/zod
TypeScript icon, indicating that this package has built-in type declarations

0.14.0 • Public • Published

TypeSchema

@typeschema/zod

License Bundle size npm downloads GitHub stars

Reusable adapter for Zod schemas
https://typeschema.com

import {initTRPC} from '@trpc/server';
import {z} from 'zod';

import {wrap} from '@typeschema/zod';

const schema = z.object({name: z.string()});

const t = initTRPC.create();
const appRouter = t.router({
  hello: t.procedure
    .input(wrap(schema))
    .query(({input}) => `Hello, ${input.name}!`),
  //         ^? {name: string}
});

Use it directly or through @typeschema/main

Dependencies

  • zod: Required for inference and validation (^3.23.8)
  • zod-to-json-schema: Required for serialization (^3.23.2)

API

Inference

  • Infer<TSchema>: Extracts the output type of a schema
  • InferIn<TSchema>: Extracts the input type of a schema

Validation

  • wrap(schema): Returns the wrapped schema with access to its operations
  • validate(schema, data): Returns the validated data or a list of validation issues
  • assert(schema, data): Returns the validated data or throws an AggregateError

Serialization

  • toJSONSchema(schema): Converts the schema into the equivalent JSON schema

Package Sidebar

Install

npm i @typeschema/zod

Weekly Downloads

3,711

Version

0.14.0

License

MIT

Unpacked Size

12.4 kB

Total Files

7

Last publish

Collaborators

  • decs