@typeschema/arktype
v0.14.0
Published
Reusable adapter for ArkType schemas
Downloads
193
Maintainers
Readme
import {initTRPC} from '@trpc/server';
import {type} from 'arktype';
import {wrap} from '@typeschema/arktype';
const schema = type({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
arktype
: Required for inference and validation (^2.0.0-rc.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