@typeschema/yup
v0.14.0
Published
Reusable adapter for Yup schemas
Downloads
1,439
Maintainers
Readme
import {initTRPC} from '@trpc/server';
import {object, string} from 'yup';
import {wrap} from '@typeschema/yup';
const schema = object({name: string().required()});
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
@sodaru/yup-to-json-schema
: Required for serialization (^2.0.1
)yup
: Required for inference and validation (^1.4.0
)
API
Inference
Infer<TSchema>
: Extracts the output type of a schemaInferIn<TSchema>
: Extracts the input type of a schema
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