Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@typeschema/yup

decs2.2kMIT0.14.0TypeScript support: included

Reusable adapter for Yup schemas

typescript, type, schema, adapter, validation, inference, assert

readme

TypeSchema

@typeschema/yup

License Bundle size npm downloads GitHub stars

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

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

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