A type system in a box + json schema

import { Type, Static } from "./typebox"

// type Foo = {
//   a: string,
//   b: number,
//   c: boolean
// }
const Foo = Type.Object({
  a: Type.String(),
  b: Type.Number(),
  c: Type.Boolean()
})

// statically resolve types
const foo: Static<typeof Foo> = { a: "hello", b: 2, c: true }

console.log(Foo)
// -> { type: 'object',
//     properties: 
//      { a: { type: 'string' },
//        b: { type: 'number' },
//        c: { type: 'boolean' } },
//     required: [ 'a', 'b', 'c' ] }

typebox is a type builder library which allows developers to compose json schema objects and allow these json schema objects to be statically resolved as TypeScript types. The aim of this project is to find parity with respect to the TypeScript type checker and JSON schema, allowing for runtime type verification using standard json schema validation that lines up to TypeScripts structural type checker.

note: typebox doesn't is only concerned with generating valid JSON schema and static resolution and does not come with a JSON schema validator. For JSON schema validation, recommend the ajv library for JavaScript.

typebox is written as a portable single file that can be copied into any typescript project. Copy the ./src/typebox.ts file into your project and you're all setup.

import { Type, Static } from "./typebox"

const TString = Type.String()

// resolve as type
type String = Static<typeof TString>

// as an argument
const f = (s: Static<typeof TString>) => { /* ... */ }

// and so on...

The following are the typebox to typescript mappings.

The following are the typebox to json schema mappings.