@typeschema/json

Reusable adapter for JSON schemas


https://typeschema.com ✨

``ts
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

$3

- Infer: Extracts the output type of a schema
- InferIn: Extracts the input type of a schema

$3

- wrap(schema): Returns the wrapped schema with access to its operations
- validate(schema, data): Returns the validated data or a list of validation issues
- assert(schema, data): Returns the validated data or throws an AggregateError

$3

- toJSONSchema(schema)`: Converts the schema into the equivalent JSON schema