🛵 TypeSchema

Universal adapter for schema validation

License NPM Downloads


Many libraries rely on some sort of type validation. Their maintainers have the choice of either to:

  1. Implement their own validation logic: which leads to more code to maintain, and we already have many good solutions out there (e.g. zod, arktype, typia)
  2. Couple their code with a specific validation library: which limits adoption by developers who use another
  3. Support multiple validation libraries: which is a burden to keep up-to-date (tRPC picked this one)

There's no best validation library because there's always a tradeoff. Each developer chooses the library that makes the most sense to them. TypeSchema solves this problem by easily providing option 3: support multiple validation libraries out-of-the-box.

Features

  • 🚀 Decouple your code from validation libraries
  • 🍃 Tiny client footprint, zero dependencies
  • ✨ Easy-to-use, minimal API

Setup

Install TypeSchema with your package manager of choice:

npm npm install @decs/typeschema
Yarn yarn add @decs/typeschema
pnpm pnpm add @decs/typeschema

Usage

import type {Infer, Schema} from '@decs/typeschema';
import {assert} from '@decs/typeschema';

// Use your favorite validation library, e.g. `zod`, `arktype`, `typia`
const schema: Schema<string> = z.string();
const schema: Schema<string> = type('string');
const schema: Schema<string> = typia.createAssert<string>();

// Extracts the schema type
type Type = Infer<typeof schema>; // `string`

// Returns the validated data or throws an exception
await assert(schema, '123'); // '123'
await assert(schema, 123); // `Error`

API

Types

  • Schema<T>
    Generic interface for schemas
  • Infer<T as Schema<unknown>>
    Extracts the equivalent TypeScript type of a schema

Functions

  • assert<T>(schema: Schema<T>, data: unknown): Promise<T>
    Returns the validated data or throws an exception

Coverage

Project Popularity Example schema Support
zod GitHub Stars z.string()
yup GitHub Stars string()
joi GitHub Stars Joi.string()
superstruct GitHub Stars string()
io-ts GitHub Stars t.string
ow GitHub Stars ow.string
typebox GitHub Stars Type.String()
typia GitHub Stars typia.createAssert<string>()
runtypes GitHub Stars String
arktype GitHub Stars type('string')

Custom validations are also supported:

export function assertString(data: unknown): string {
  if (typeof data !== 'string') {
    throw new Error('Expected a string, got: ' + data);
  }
  return data;
}

await assert(assertString, '123'); // Returns '123'
await assert(assertString, 123); // Throws an exception

Acknowledgements