@decs/typeschema

🌙 TypeSchema

Unified interface for TypeScript schema validations

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} from '@decs/typeschema';
import {assert} from '@decs/typeschema';

// Use your favorite validation library
const schema = [...];

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

// Returns the validated value or throws an exception
await assert(schema, value);

Coverage

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

Custom validations are also supported:

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

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