Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@typeschema/arktype

decs120MIT0.14.0TypeScript support: included

Reusable adapter for ArkType schemas

typescript, type, schema, adapter, validation, inference, assert

readme

TypeSchema

@typeschema/arktype

License Bundle size npm downloads GitHub stars

Reusable adapter for ArkType schemas
https://typeschema.com

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