Détail du package

@typeschema/typebox

decs4.2kMIT0.14.0

Reusable adapter for TypeBox schemas

typescript, type, schema, adapter

readme

TypeSchema

@typeschema/typebox

License Bundle size npm downloads GitHub stars

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

import {Type} from '@sinclair/typebox';
import {initTRPC} from '@trpc/server';

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

const schema = Type.Object({name: Type.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

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