@typeschema/typebox
v0.14.0
Published
Reusable adapter for TypeBox schemas
Downloads
2,566
Maintainers
Readme
import {Type} from '@sinclair/typebox';
import {initTRPC} from '@trpc/server';
import {wrap} from '@typeschema/typebox';
const schema = Type.Object({name: Type.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
@sinclair/typebox
: Required for inference, validation, and serialization (^0.33.7
)
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