diff --git a/docs/benchmark.md b/docs/benchmark.md index 48557c4..cc03d73 100644 --- a/docs/benchmark.md +++ b/docs/benchmark.md @@ -1,4 +1,4 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](./readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # Benchmark diff --git a/docs/contributing.md b/docs/contributing.md index d592385..b9ee9ec 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,4 +1,4 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](./readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # Contributing diff --git a/docs/ecosystem.md b/docs/ecosystem.md index 0ffca1e..03c8a39 100644 --- a/docs/ecosystem.md +++ b/docs/ecosystem.md @@ -1,4 +1,4 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](../readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # Ecosystem @@ -25,16 +25,10 @@ The following is a list of community packages that offer general tooling, extend | [typebox-form-parser](https://github.com/jtlapp/typebox-form-parser) | Parses form and query data based on TypeBox schemas | | [typebox-schema-faker](https://github.com/iam-medvedev/typebox-schema-faker) | Generate fake data from TypeBox schemas for testing, prototyping and development | -## TypeBox Workbench - -TypeBox offers a web based code generation tool that can convert TypeScript types into TypeBox types as well as several other ecosystem libraries. - -[TypeBox Workbench Link Here](https://git.alk.dev/alkdev/typebox/) - ## TypeBox Codegen TypeBox provides a code generation library that can be integrated into toolchains to automate type translation between TypeScript and TypeBox. This library also includes functionality to transform TypeScript types to other ecosystem libraries. -[TypeBox Codegen Link Here](https://git.alk.dev/alkdev/typebox-codegen) +[@alkdev/typebox-codegen](https://git.alk.dev/alkdev/typebox-codegen) Back to [Home](../readme.md) diff --git a/docs/error-function.md b/docs/error-function.md index 74af619..bb499d2 100644 --- a/docs/error-function.md +++ b/docs/error-function.md @@ -1,4 +1,4 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](./readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # Error Function diff --git a/docs/installation.md b/docs/installation.md index a7e9e23..098a7b9 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,11 +1,7 @@ # Installation -For the latest version use [TypeBox 1.x](https://git.alk.dev/alkdev/typebox) - ```bash -$ npm install @alkdev/typebox # TypeBox 0.x - Long Term Support - -$ npm install typebox # TypeBox 1.x - Latest +$ npm install @alkdev/typebox ``` --- diff --git a/docs/overview.md b/docs/overview.md deleted file mode 100644 index 0f473e3..0000000 --- a/docs/overview.md +++ /dev/null @@ -1,49 +0,0 @@ -# Overview - -
- -

TypeBox

- -

Json Schema Type Builder with Static Type Resolution for TypeScript

- -
-
- -[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) - -
- -## Example - -```typescript -import { Type, type Static } from "@alkdev/typebox"; - -const T = Type.Object({ - // const T = { - x: Type.Number(), // type: 'object', - y: Type.Number(), // required: ['x', 'y', 'z'], - z: Type.Number(), // properties: { -}); // x: { type: 'number' }, -// y: { type: 'number' }, -// z: { type: 'number' } -// } -// } - -type T = Static; // type T = { -// x: number, -// y: number, -// z: number -// } -``` - -## Overview - -TypeBox is a runtime type builder 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 that can be statically checked by TypeScript and runtime asserted using standard Json Schema validation. - -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 - ---- - -[Back to Home](../readme.md) diff --git a/docs/syntax/create.md b/docs/syntax/create.md index d03389c..22de72c 100644 --- a/docs/syntax/create.md +++ b/docs/syntax/create.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Create diff --git a/docs/syntax/generics.md b/docs/syntax/generics.md index 5431803..424a395 100644 --- a/docs/syntax/generics.md +++ b/docs/syntax/generics.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Generics diff --git a/docs/syntax/noinfer.md b/docs/syntax/noinfer.md index d421c09..1060b25 100644 --- a/docs/syntax/noinfer.md +++ b/docs/syntax/noinfer.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # NoInfer diff --git a/docs/syntax/options.md b/docs/syntax/options.md index acd2c32..3d6be09 100644 --- a/docs/syntax/options.md +++ b/docs/syntax/options.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Options diff --git a/docs/syntax/parameters.md b/docs/syntax/parameters.md index 28280b0..370e36f 100644 --- a/docs/syntax/parameters.md +++ b/docs/syntax/parameters.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | [Values](../values/) | **Syntax** | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Parameters diff --git a/docs/type-check.md b/docs/type-check.md index 7801c62..d75630f 100644 --- a/docs/type-check.md +++ b/docs/type-check.md @@ -1,4 +1,4 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](./readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # TypeCheck diff --git a/docs/type-map.md b/docs/type-map.md index 95c46cd..f2c377c 100644 --- a/docs/type-map.md +++ b/docs/type-map.md @@ -1,23 +1,23 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](../readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # TypeMap TypeBox offers an external package for bidirectional mapping between TypeBox, Valibot, and Zod type libraries. It also includes syntax parsing support for Valibot and Zod and supports the Standard Schema specification. For more details on TypeMap, refer to the project repository. -[TypeMap Repository](https://git.alk.dev/alkdev/typebox) +[@alkdev/typemap](https://git.alk.dev/alkdev/typebox) ## Usage TypeMap needs to be installed separately ```bash -$ npm install @sinclair/typemap +$ npm install @alkdev/typemap ``` Once installed it offers advanced structural remapping between various runtime type libraries ([Example](https://www.typescriptlang.org/play/?moduleResolution=99&module=199&ts=5.8.0-beta#code/JYWwDg9gTgLgBAbzgFQJ5gKYCEIA8A0cAyqgHYwCGBcAWhACZwC+cAZlBCHAOQACAzsFIBjADYVgUAPQx0GEBTDcAUMuERS-eMjgBeFHJy4AFAAMkuAFxxSAVxAAjDFEKprdx88IAvd-adQzKYAlHBwUlJw6pra1sgA8g4AVhjCMAA8CMphObl5+QWFRcW5ETlWKABy-s4A3NkljU3NBWVhblU1UPUtvX3FbXC+nZ7dDf0TE2VMAHyq0VrEesRklCbIoS1lC-BE1twWfqOuRwE+p87MKmoaiwBKy3T0xkTBAHRgFFD8GMZ2oqJNnltrd4HdrFlJltImEKh4Aj0oU1Bh14XVxkiBjChhcxpjGtMwkA)) ```typescript -import { TypeBox, Syntax, Zod } from "@sinclair/typemap"; +import { TypeBox, Syntax, Zod } from "@alkdev/typemap"; const T = TypeBox(`{ x: number, y: number, z: number }`); // const T: TObject<{ // x: TNumber; diff --git a/docs/type-registry.md b/docs/type-registry.md index e96d855..83c239c 100644 --- a/docs/type-registry.md +++ b/docs/type-registry.md @@ -1,4 +1,4 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](./readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # TypeRegistry diff --git a/docs/type-system.md b/docs/type-system.md index e0297f2..79248bd 100644 --- a/docs/type-system.md +++ b/docs/type-system.md @@ -1,4 +1,4 @@ -[Overview](./overview.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) +[Home](./readme.md) | [Installation](./installation.md) | [Usage](./usage.md) | [Types](./types/) | [Values](./values/) | [Syntax](./syntax/) | [TypeRegistry](./type-registry.md) | [TypeCheck](./type-check.md) # TypeSystem diff --git a/docs/types/conditional.md b/docs/types/conditional.md index e9b0d4b..b279068 100644 --- a/docs/types/conditional.md +++ b/docs/types/conditional.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Conditional Types diff --git a/docs/types/generics.md b/docs/types/generics.md index 063d10c..8d75dd8 100644 --- a/docs/types/generics.md +++ b/docs/types/generics.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Generic Types diff --git a/docs/types/indexed.md b/docs/types/indexed.md index afc4783..9cb4859 100644 --- a/docs/types/indexed.md +++ b/docs/types/indexed.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Indexed Access Types diff --git a/docs/types/javascript.md b/docs/types/javascript.md index 7616f04..aa2b683 100644 --- a/docs/types/javascript.md +++ b/docs/types/javascript.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # JavaScript Types diff --git a/docs/types/json.md b/docs/types/json.md index 1397936..b00eaa0 100644 --- a/docs/types/json.md +++ b/docs/types/json.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Json Types diff --git a/docs/types/mapped.md b/docs/types/mapped.md index 6b2977b..6653fde 100644 --- a/docs/types/mapped.md +++ b/docs/types/mapped.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Mapped Types diff --git a/docs/types/modules.md b/docs/types/modules.md index e29ab1f..961c483 100644 --- a/docs/types/modules.md +++ b/docs/types/modules.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Module Types diff --git a/docs/types/options.md b/docs/types/options.md index fb9e2d2..e32c7df 100644 --- a/docs/types/options.md +++ b/docs/types/options.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Options diff --git a/docs/types/properties.md b/docs/types/properties.md index 8b3e6a2..bcf13d4 100644 --- a/docs/types/properties.md +++ b/docs/types/properties.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Properties diff --git a/docs/types/recursive.md b/docs/types/recursive.md index f995e2b..ec20427 100644 --- a/docs/types/recursive.md +++ b/docs/types/recursive.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Recursive Types diff --git a/docs/types/template-literal.md b/docs/types/template-literal.md index daa6b13..d349262 100644 --- a/docs/types/template-literal.md +++ b/docs/types/template-literal.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Template Literal Types diff --git a/docs/types/transform.md b/docs/types/transform.md index 4309502..7cc8992 100644 --- a/docs/types/transform.md +++ b/docs/types/transform.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Transform Types diff --git a/docs/types/typeguard.md b/docs/types/typeguard.md index 365e466..44f04d7 100644 --- a/docs/types/typeguard.md +++ b/docs/types/typeguard.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # TypeGuard diff --git a/docs/types/unsafe.md b/docs/types/unsafe.md index 16b82d7..484ad16 100644 --- a/docs/types/unsafe.md +++ b/docs/types/unsafe.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | **Types** | [Values](../values/) | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Unsafe Types diff --git a/docs/values/assert.md b/docs/values/assert.md index bc235c8..5bab24e 100644 --- a/docs/values/assert.md +++ b/docs/values/assert.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Assert diff --git a/docs/values/cast.md b/docs/values/cast.md index f149739..58ebdb0 100644 --- a/docs/values/cast.md +++ b/docs/values/cast.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Cast diff --git a/docs/values/check.md b/docs/values/check.md index ea4ded2..d1a1081 100644 --- a/docs/values/check.md +++ b/docs/values/check.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Check diff --git a/docs/values/clean.md b/docs/values/clean.md index 04b7b51..32d346b 100644 --- a/docs/values/clean.md +++ b/docs/values/clean.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Clean diff --git a/docs/values/clone.md b/docs/values/clone.md index 42b9999..2f7314e 100644 --- a/docs/values/clone.md +++ b/docs/values/clone.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Clone diff --git a/docs/values/convert.md b/docs/values/convert.md index 6c4de28..e3f2e22 100644 --- a/docs/values/convert.md +++ b/docs/values/convert.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Convert diff --git a/docs/values/create.md b/docs/values/create.md index de3291a..635c2b5 100644 --- a/docs/values/create.md +++ b/docs/values/create.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Create diff --git a/docs/values/decode-encode.md b/docs/values/decode-encode.md index b39c4c9..5883d13 100644 --- a/docs/values/decode-encode.md +++ b/docs/values/decode-encode.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Decode / Encode diff --git a/docs/values/default.md b/docs/values/default.md index 4c7d76d..ceacf39 100644 --- a/docs/values/default.md +++ b/docs/values/default.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Default diff --git a/docs/values/diff-patch.md b/docs/values/diff-patch.md index af2fef2..5f5fb8f 100644 --- a/docs/values/diff-patch.md +++ b/docs/values/diff-patch.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Diff / Patch diff --git a/docs/values/equal.md b/docs/values/equal.md index 91cbbc4..46e9e08 100644 --- a/docs/values/equal.md +++ b/docs/values/equal.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Equal diff --git a/docs/values/errors.md b/docs/values/errors.md index 2bbcaf5..bf99423 100644 --- a/docs/values/errors.md +++ b/docs/values/errors.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Errors diff --git a/docs/values/hash.md b/docs/values/hash.md index a1d1393..7748cfc 100644 --- a/docs/values/hash.md +++ b/docs/values/hash.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Hash diff --git a/docs/values/mutate.md b/docs/values/mutate.md index 08b7c33..c7130c5 100644 --- a/docs/values/mutate.md +++ b/docs/values/mutate.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Mutate diff --git a/docs/values/parse.md b/docs/values/parse.md index 44da927..3609c5b 100644 --- a/docs/values/parse.md +++ b/docs/values/parse.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Parse diff --git a/docs/values/pointer.md b/docs/values/pointer.md index cbb2da1..d6a1af1 100644 --- a/docs/values/pointer.md +++ b/docs/values/pointer.md @@ -1,4 +1,4 @@ -[Overview](../overview.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) +[Home](../../readme.md) | [Installation](../installation.md) | [Usage](../usage.md) | [Types](../types/) | **Values** | [Syntax](../syntax/) | [TypeRegistry](../type-registry.md) | [TypeCheck](../type-check.md) # Pointer diff --git a/readme.md b/readme.md index fa2e8ec..a17711e 100644 --- a/readme.md +++ b/readme.md @@ -11,18 +11,24 @@ +## About This Fork + +This is the **@alkdev/typebox** fork — a community-maintained LTS branch of TypeBox 0.x. The original TypeBox project has been rewritten as 1.x with breaking changes; this fork continues the 0.x API that many projects depend on, with minimal maintenance overhead since the feature set is essentially complete. + +- **Supply chain security**: Published from our own infrastructure; no dependency on upstream publish access. +- **Stability**: No breaking rewrites planned. Bug fixes and compatibility patches only. +- **Drop-in replacement**: `@alkdev/typebox` is API-compatible with `@sinclair/typebox` 0.x. + ## Overview TypeBox is a runtime type builder 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 that can be statically checked by TypeScript and runtime asserted using standard Json Schema validation. -See [Overview →](docs/overview.md) +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. ## Install ```bash -$ npm install @alkdev/typebox # TypeBox 0.x - Long Term Support - -$ npm install typebox # TypeBox 1.x - Latest +$ npm install @alkdev/typebox ``` See [Installation →](docs/installation.md)