@typeschema/yup

Reusable adapter for Yup schemas


https://typeschema.com ✨

``ts
import {initTRPC} from '@trpc/server';
import {object, string} from 'yup';

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

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

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


- @sodaru/yup-to-json-schema: Required for serialization (^2.0.1)
- yup: Required for inference and validation (^1.4.0)

API

$3

- Infer: Extracts the output type of a schema
- InferIn: Extracts the input type of a schema

$3

- 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

$3

- toJSONSchema(schema)`: Converts the schema into the equivalent JSON schema