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

Package detail

@typeschema/runtypes

decs117MIT0.14.0TypeScript support: included

Reusable adapter for Runtypes schemas

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

readme

TypeSchema

@typeschema/runtypes

License Bundle size npm downloads GitHub stars

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

import {initTRPC} from '@trpc/server';
import {Record, String} from 'runtypes';

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

const schema = Record({name: 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

  • runtypes: Required for inference and validation (^6.7.0)

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