$ npm install typeboximport Type from 'typebox'
const T = Type.Object({ // const T = {
x: Type.Number(), // type: 'object',
y: Type.Number(), // properties: {
z: Type.Number() // x: { type: 'number' },
}) // y: { type: 'number' },
// z: { type: 'number' }
// },
// required: ['x', 'y', 'z']
// }
type T = Type.Static<typeof T> // type T = {
// x: number,
// y: number,
// z: number
// }TypeBox is a runtime type system that creates in-memory JSON Schema objects that infer as TypeScript types. The schematics produced by this library are designed to match the static type checking rules of the TypeScript compiler. TypeBox offers a unified type system that can be statically checked by TypeScript and validated at runtime using standard JSON Schema.
This library is designed to allow JSON Schema to compose similar to how types compose within TypeScript's type system. It can be used as a simple tool to build up complex schematics or integrated into REST and RPC services to help validate data received over the wire.
License: MIT
TypeBox types are JSON Schema fragments that can compose into more complex types. The library offers a set of types used to construct JSON Schema compliant schematics as well as a set of extended types used to model constructs native to the JavaScript language. The schematics produced by TypeBox can be passed directly to any JSON Schema compliant validator.
The following creates a User type and infers with Static.
import Type from 'typebox'
// -------------------------------------------------------------------------------
// Type
// -------------------------------------------------------------------------------
const User = Type.Object({ // const User = {
id: Type.String(), // type: 'object',
name: Type.String(), // properties: {
email: Type.String({ format: 'email' }) // id: { type: 'string' },
}) // name: { type: 'string' },
// email: {
// type: 'string',
// format: 'email'
// }
// }
// required: [
// 'id',
// 'name',
// 'email'
// ]
// }
// -------------------------------------------------------------------------------
// Static
// -------------------------------------------------------------------------------
type User = Type.Static<typeof User> // type User = {
// id: string,
// name: string,
// email: string
// }Documentation | Example 1 | Example 2
TypeBox can transform TypeScript definitions into JSON Schema. The Script function provides an optional programmatic syntax to rapidly convert type definitions into JSON Schema, or serve more generally as an alternative to Type.* builders. The Script function is designed to handle a wide array of complex TypeScript type-level expressions.
The following uses the Script function to parse TypeScript interfaces into JSON Schema.
import Type from 'typebox'
// -------------------------------------------------------------------------------
// Script
// -------------------------------------------------------------------------------
const { User, UserUpdate } = Type.Script(`
interface Entity {
id: string
}
interface User extends Entity {
name: string,
email: string
}
type UserUpdate = Evaluate<
Pick<User, keyof Entity> &
Partial<Omit<User, keyof Entity>>
>
`)
// -------------------------------------------------------------------------------
// Reflect
// -------------------------------------------------------------------------------
console.log(User) // {
// type: 'object',
// properties: {
// id: { type: 'string' },
// name: { type: 'string' },
// email: { type: 'string' }
// },
// required: [
// 'id',
// 'name',
// 'email'
// ]
// }
console.log(UserUpdate) // {
// type: 'object',
// properties: {
// id: { type: 'string' },
// name: { type: 'string' },
// email: { type: 'string' }
// },
// required: ['id']
// }
// -------------------------------------------------------------------------------
// Static
// -------------------------------------------------------------------------------
type User = Type.Static<typeof User> // type User = {
// id: string,
// name: string,
// email: string
// }
type UserUpdate = Type.Static<typeof UserUpdate> // type UserUpdate = {
// id: string,
// name?: string,
// email?: string
// }Documentation | Example 1 | Example 2
TypeBox includes a high performance validation compiler for JSON Schema. The compiler supports both TypeBox and native JSON Schema schematics, and will convert them into optimized runtime validation routines. The compiler is designed to be a lightweight 2020-12 spec compliant alternative to Ajv for high-throughput applications.
The following uses the Schema submodule to compile a TypeBox type.
import Schema from 'typebox/schema'
// -------------------------------------------------------------------------------
// Compile
// -------------------------------------------------------------------------------
const User = Schema.Compile(Type.Object({
id: Type.String(),
name: Type.String(),
email: Type.String({ format: 'email' })
}))
// -------------------------------------------------------------------------------
// Parse
// -------------------------------------------------------------------------------
const user = User.Parse({ // const user: {
id: '65f1a2b3c4d5e6f7a8b9c0d1', // id: string,
name: 'user', // name: string,
email: 'user@domain.com' // email: string
}) // } = ...TypeBox provides two distinct versions that span two generations of the TypeScript compiler.
| TypeBox | TypeScript | Description |
|---|---|---|
| 1.x | 6.0 - 7.0+ | Latest. Developed against the TypeScript 7 native compiler. Provides advanced type inference and native JSON Schema 2020-12 support. Includes backwards compatibility with 0.x types. ESM only. |
| 0.x | 5.0 - 6.0 | LTS. Developed against older TypeScript versions and actively maintained under Long Term Support. Compatible with both ESM and CJS. Issues should be submitted to the Sinclair TypeBox repository. |
TypeBox is open to community contribution. Please ensure you submit an issue before submitting a pull request. The TypeBox project prefers open community discussion before accepting new features.