Next

Author: sinclairzx81

deno.jsonc

@@ -42,7 +42,6 @@
     // --------------------------------------------------------------
     // Package Entry
     // --------------------------------------------------------------
-    "typebox/compile": "./src/compile/index.ts",
     "typebox/error": "./src/error/index.ts",
     "typebox/format": "./src/format/index.ts",
     "typebox/guard": "./src/guard/index.ts",

design/website/app/frontend/components/docs/docs.tsx

@@ -49,11 +49,10 @@ interface Manifest {
 const TOP_LEVEL_ORDER = [
   'overview',
   'type',
-  'script',
-  'schema',
   'value',
+  'schema',
   'format',
-  'compile',
+  'script',
   'system',
 ]
 // ------------------------------------------------------------------

design/website/app/frontend/components/home/home.tsx

@@ -97,7 +97,7 @@ export function Home() {
     <div className='home'>
       <div className='home-card'>
         <TypeBoxLogo />
-        <h1>TypeBox</h1>
+        <h1>TypeBox<sup style={{ marginLeft: '0.4em', color: '#e0c285', fontSize: '0.6em' }}>2</sup></h1>
         <AnimatedSubHeading
           intervalMs={5000}
           stepDelayMs={25}

design/website/docs/compile/0_compile.md

@@ -42,22 +42,19 @@ const S = C.Parse({ x: 1, y: 2, z: 3 })             // const S: {
 // Errors
 // ------------------------------------------------------------------
 const E = C.Errors(T, { x: null })                  // const E = [
-                                                    //   false,
-                                                    //   [
-                                                    //     {
-                                                    //       keyword: "required",
-                                                    //       schemaPath: "#",
-                                                    //       instancePath: "",
-                                                    //       params: { requiredProperties: [ "y", "z" ] },
-                                                    //       message: "must have required properties y, z"
-                                                    //     },
-                                                    //     {
-                                                    //       keyword: "type",
-                                                    //       schemaPath: "#/properties/x",
-                                                    //       instancePath: "/x",
-                                                    //       params: { type: "number" },
-                                                    //       message: "must be number"
-                                                    //     }
-                                                    //   ]
+                                                    //   {
+                                                    //     keyword: "required",
+                                                    //     schemaPath: "#",
+                                                    //     instancePath: "",
+                                                    //     params: { requiredProperties: [ "y", "z" ] },
+                                                    //     message: "must have required properties y, z"
+                                                    //   },
+                                                    //   {
+                                                    //     keyword: "type",
+                                                    //     schemaPath: "#/properties/x",
+                                                    //     instancePath: "/x",
+                                                    //     params: { type: "number" },
+                                                    //     message: "must be number"
+                                                    //   }
                                                     // ]
 ```

design/website/docs/compile/1_validator.md

@@ -0,0 +1,36 @@
+# Schema.Accelerate
+
+TypeBox attains high performance by compiling JSON schematics into optimized JavaScript validation routines. These routines are evaluated at runtime within the environment; a technique known as Just-In-Time (JIT) compilation.
+
+TypeBox takes measures to ensure evaluation is safe, however some environments do restrict runtime code evaluation by preventing calls to `eval()` or `new Function()`. In such cases, acceleration will not be possible. TypeBox will automatically fall back to interpreted dynamic checking if it detects a restrictive [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CSP).
+
+
+## IsAccelerated
+
+You can check if a compiled Validator is using accleration with the IsAccelerated function.
+
+ ```typescript
+import { Compile } from 'typebox/schema'
+
+const C = Compile(Type.String())
+
+console.log(C.IsAccelerated()) // true if accelerated
+```
+
+## Disable Acceleration
+
+You can disable all acceleration with the following system setting.
+
+```typescript
+import System from 'typebox/system'
+
+System.Settings.Set({ useAcceleration: false })   // default is true
+
+// ...
+
+const C = Schema.Compile(Type.String())
+
+console.log(C.IsAccelerated())                    // will be false
+
+
+```