alkdev/typebox
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up docs for publishing: add fork context, remove upstream references, fix nav links

Browse Source
This commit is contained in:
glm-5.1
2026-04-23 14:16:23 +00:00
parent f8b2cdd5a4
commit ca34609ec0
46 changed files with 58 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
readme.md
View File

@@ -11,18 +11,24 @@
</div>
## 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 &rarr;](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 &rarr;](docs/installation.md)