@typeschema/runtypes
v0.14.0
Published
Reusable adapter for Runtypes schemas
Downloads
208
Maintainers
Readme
import {initTRPC} from '@trpc/server';
import {Record, String} from 'runtypes';
import {wrap} from '@typeschema/runtypes';
const schema = Record({name: 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
runtypes
: Required for inference and validation (^6.7.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