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

0.14.0 • Public • Published

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

Package Sidebar

Install

npm i @typeschema/yup

Weekly Downloads

317

Version

0.14.0

License

MIT

Unpacked Size

13.7 kB

Total Files

7

Last publish

Collaborators

  • decs