@typeschema/joi
v0.14.0
Published
Reusable adapter for Joi schemas
Downloads
206
Maintainers
Readme
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 operationsvalidate(schema, data)
: Returns the validated data or a list of validation issuesassert(schema, data)
: Returns the validated data or throws anAggregateError
Serialization
toJSONSchema(schema)
: Converts the schema into the equivalent JSON schema