You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -357,13 +357,23 @@ The TypeBox compiler is tested against the [Official JSON Schema Test Suite](htt
357
357
358
358
## Versions
359
359
360
-
TypeBox provides two distinct versions that span two generations of the TypeScript compiler.
360
+
TypeBox ships two distinct versions that span two generations of the TypeScript compiler.
361
+
362
+
```bash
363
+
$ npm install typebox # 1.x
364
+
365
+
$ npm install @sinclair/typebox # 0.x
366
+
```
367
+
368
+
These versions are summarized with the following.
361
369
362
370
| TypeBox | TypeScript | Description |
363
371
| :--- | :--- | :--- |
364
372
| 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.**|
365
373
| 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](https://github.com/sinclairzx81/sinclair-typebox) repository. |
366
374
375
+
New applications should use 1.x. The 0.x version is maintained under LTS support for existing users.
376
+
367
377
## Contribute
368
378
369
379
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.
0 commit comments