Skip to content

Latest commit

 

History

History

vine

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

TypeSchema

@typeschema/vine

License Bundle size npm downloads GitHub stars

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

import {initTRPC} from '@trpc/server';
import vine from '@vinejs/vine';

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

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

  • @vinejs/vine: Required for inference and validation (^2.1.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