Skip to content

Commit

Permalink
modifiers
Browse files Browse the repository at this point in the history
  • Loading branch information
sinclairzx81 committed Jul 28, 2023
1 parent 3eaf71b commit 3dff435
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,24 @@ type T = Static<typeof T> // type T = {
## Overview
TypeBox is a runtime type builder that creates in-memory JSON Schema objects that can be statically inferred as TypeScript types. The schemas produced by this library are designed to match the static type assertion rules of the TypeScript compiler. TypeBox enables one to create a unified type that can be statically checked by TypeScript and runtime asserted using standard JSON Schema validation.
This library is designed to enable JSON schema to compose with the same flexibility as TypeScript's type system. It can be used as a simple tool to build up complex schemas or integrated into REST or RPC services to help validate data received over the wire.
TypeBox is a runtime type builder that creates in-memory JSON Schema objects that can be statically inferred as TypeScript types. The schemas produced by this library are designed to match the static type assertion rules of the TypeScript language. It allows one to create a unified runtime type that can be statically checked by TypeScript and runtime asserted using standards compliant JSON Schema validation. This library can be used as a simple tool to build up complex schemas or integrated into REST or RPC frameworks to help validate data received over the wire.
License MIT
## Features
TypeBox offers the following features
- **Unified Runtime Type**: TypeBox creates a runtime type that is consistent with TypeScript's type system, allowing you to leverage static type checking while also performing runtime JSON Schema validation.
- **Composable Schemas**: TypeBox is designed to enable JSON schemas to compose with the same flexibility and sophistication as TypeScript's type system. This means you can build complex schemas by combining smaller ones.
- **Type-Safe Operations on Dynamic Data**: TypeBox offers advanced utilities for performing type-safe operations on dynamic data, which can be particularly useful when dealing with data from external sources.
- **High-Performance JIT Validation Compiler**: TypeBox boasts the fastest high-performance JIT validation compiler available for JavaScript, which ensures efficient runtime validation of JSON data against the generated schemas.
- **Versatility for Integration**: TypeBox can be used as a standalone tool to build complex schemas or seamlessly integrated into REST or RPC frameworks to validate data received over the network.
## Contents
- [Install](#install)
- [Overview](#overview)
Expand Down

0 comments on commit 3dff435

Please sign in to comment.