包详细信息

@typeschema/joi

decs99MIT0.14.0

Reusable adapter for Joi schemas

typescript, type, schema, adapter

自述文件

TypeSchema

@typeschema/joi

License Bundle size npm downloads GitHub stars

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

import {initTRPC} from '@trpc/server';
import Joi from 'joi';

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

const schema = Joi.object({name: Joi.string().required()});

const t = initTRPC.create();
const appRouter = t.router({
  hello: t.procedure
    .input(wrap(schema))
    .query(({input}) => `Hello, ${(input as any).name}!`),
  //         ^? unknown
});

Use it directly or through @typeschema/main

Dependencies

  • joi: Required for validation (^17.13.3)
  • joi-to-json: Required for serialization (^4.3.0)

API

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