@sinclair/typebox 0.32.0-dev-15 → 0.32.0-dev-17

package/readme.md

@@ -20,7 +20,6 @@
 
 ## Install
 
-#### Npm
 ```bash
 $ npm install @sinclair/typebox --save
 ```
@@ -65,9 +64,9 @@ License MIT
 - [Types](#types)
   - [Json](#types-json)
   - [JavaScript](#types-javascript)
+  - [Modules](#types-modules)
   - [Options](#types-options)
   - [Properties](#types-properties)
-  - [Modular](#types-modular)
   - [Generics](#types-generics)
   - [References](#types-references)
   - [Recursive](#types-recursive)
@@ -644,6 +643,28 @@ TypeBox provides an extended type set that can be used to create schematics for
 └────────────────────────────────┴─────────────────────────────┴────────────────────────────────┘
 ```
 
+<a name='types-modules'></a>
+
+### Modules
+
+TypeBox has a modular type system that supports selective type imports. Using selective imports can be useful in resource constrained environments as the technique enables modern bundlers to tree shake unused code leading to reduced bundle sizes. The following selectively imports a few types.
+
+```typescript
+import { Object, Number, String, Boolean, type Static } from '@sinclair/typebox'
+
+const T = Object({                                   // const T: TObject<{
+  x: Number(),                                       //  x: TNumber,
+  y: String(),                                       //  y: TString,
+  z: Boolean()                                       //  z: TBoolean
+})                                                   // }>
+
+type T = Static<typeof T>                            // type T = { 
+                                                     //   x: number, 
+                                                     //   y: string, 
+                                                     //   z: boolean 
+                                                     // }
+```
+
 <a name='types-options'></a>
 
 ### Options
@@ -717,20 +738,6 @@ Object properties can be modified with Readonly and Optional. The following tabl
 └────────────────────────────────┴─────────────────────────────┴────────────────────────────────┘
 ```
 
-<a name='types-modular'></a>
-
-### Modular Types
-
-TypeBox implements a modular type system. The following imports the full type system (recommended)
-
-```typescript
-import { Type } from '@sinclair/typebox'             // 36.5 kb minified
-```
-The following imports types individually which enables modern bundlers to optimize bundle sizes via tree shaking.
-```typescript
-import { Object, Number } from '@sinclair/typebox'   // 6.4 kb minified
-```
-
 <a name='types-generics'></a>
 
 ### Generic Types
@@ -950,7 +957,7 @@ const M = Type.Mapped(Type.KeyOf(T), K => {          // type M = {
 
 ### Template Literal Types
 
-TypeBox supports Template Literal types with Type.TemplateLiteral. This type can be created using a syntax similar to the TypeScript Template Literal syntax. TypeBox encodes Template Literals as regular expression string patterns which enables the template to be checked by Json Schema validators. This type also supports regular expression parsing, enabling template patterns to be used for generative types. The following shows both TypeScript and TypeBox usage.
+TypeBox supports template literals with Type.TemplateLiteral. This type can be created using a syntax similar to the TypeScript template literal syntax or composed from exterior types. TypeBox encodes template literals as regular expression patterns which enables the template to be checked by Json Schema validators. This type also supports regular expression parsing, enabling template patterns to be used for generative types. The following shows both TypeScript and TypeBox usage.
 
 ```typescript
 // TypeScript
@@ -1808,11 +1815,11 @@ The following table lists esbuild compiled and minified sizes for each TypeBox m
 ┌──────────────────────┬────────────┬────────────┬─────────────┐
 │       (index)        │  Compiled  │  Minified  │ Compression │
 ├──────────────────────┼────────────┼────────────┼─────────────┤
-│ typebox/compiler     │ '118.3 kb' │ ' 52.4 kb' │  '2.26 x'   │
+│ typebox/compiler     │ '118.7 kb' │ ' 52.5 kb' │  '2.26 x'   │
 │ typebox/errors       │ ' 55.1 kb' │ ' 25.2 kb' │  '2.19 x'   │
 │ typebox/system       │ '  4.6 kb' │ '  2.0 kb' │  '2.31 x'   │
-│ typebox/value        │ '144.0 kb' │ ' 61.5 kb' │  '2.34 x'   │
-│ typebox              │ ' 87.0 kb' │ ' 36.5 kb' │  '2.39 x'   │
+│ typebox/value        │ '144.8 kb' │ ' 61.8 kb' │  '2.34 x'   │
+│ typebox              │ ' 87.7 kb' │ ' 36.7 kb' │  '2.39 x'   │
 └──────────────────────┴────────────┴────────────┴─────────────┘
 ```