0.1.0 • Published 3 months ago

@typeschema/suretype v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago
import {initTRPC} from '@trpc/server';
import {v} from 'suretype';

import {wrap} from '@typeschema/suretype';

const schema = v.object({
  name: v.string().required(),
});

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

  • suretype: Required for inference, validation, and serialization (^3.3.1)

API

Inference

  • Infer<TSchema>: Extracts the output type of a schema
  • InferIn<TSchema>: Extracts the input type of a schema

Validation

  • 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

Serialization

  • toJSONSchema(schema): Converts the schema into the equivalent JSON schema