@typeschema/json
v0.14.0
Published
Reusable adapter for JSON schemas
Downloads
147
Maintainers
Readme
import {initTRPC} from '@trpc/server';
import {wrap} from '@typeschema/json';
const schema = {
additionalProperties: false,
properties: {name: {type: 'string'}},
required: ['name'],
type: 'object',
} as const;
const t = initTRPC.create();
const appRouter = t.router({
hello: t.procedure
.input(wrap(schema))
.query(({input}) => `Hello, ${(input as any).name}!`),
// ^? {name: string}
});
Use it directly or through @typeschema/main
Dependencies
ajv
: Required for validation and serialization (^8.17.1
)json-schema-to-ts
: Required for inference (^3.1.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