@typeschema/zod
v0.14.0
Published
Reusable adapter for Zod schemas
Downloads
12,534
Maintainers
Readme
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 schemaInferIn<TSchema>
: Extracts the input type of a schema
Validation
wrap(schema)
: Returns the wrapped schema with access to its operationsvalidate(schema, data)
: Returns the validated data or a list of validation issuesassert(schema, data)
: Returns the validated data or throws anAggregateError
Serialization
toJSONSchema(schema)
: Converts the schema into the equivalent JSON schema