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

Package detail

@typeschema/main

decs7.8kMIT0.14.1TypeScript support: included

Universal adapter for schema validation

typescript, type, schema, adapter, validation, inference, assert, arktype, class-validator, deepkit, effect, fastest-validator, function, io-ts, joi, json, ow, runtypes, superstruct, suretype, typebox, valibot, valita, vine, yup, zod

readme

TypeSchema

@typeschema/main

License Bundle size npm downloads GitHub stars

Universal adapter for schema validation
https://typeschema.com ✨

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