@typeschema/io-ts
v0.14.0
Published
Reusable adapter for io-ts schemas
Downloads
36
Maintainers
Readme
import {initTRPC} from '@trpc/server';
import * as ioTs from 'io-ts';
import {wrap} from '@typeschema/io-ts';
const schema = ioTs.type({name: ioTs.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
fp-ts: Required for inference and validation (^2.16.9)io-ts: Required for inference and validation (^2.2.21)
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
