@sinclair/typebox 0.32.0-dev-18 → 0.32.0-dev-19

package/build/require/value/transform/has.js

@@ -2,83 +2,89 @@
 
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HasTransform = void 0;
+const index_1 = require("../deref/index");
+const index_2 = require("../../type/symbols/index");
+// ------------------------------------------------------------------
+// TypeGuard
+// ------------------------------------------------------------------
 const type_1 = require("../../type/guard/type");
-const index_1 = require("../guard/index");
-const index_2 = require("../deref/index");
-const index_3 = require("../../type/symbols/index");
+// ------------------------------------------------------------------
+// ValueGuard
+// ------------------------------------------------------------------
+const index_3 = require("../guard/index");
 // prettier-ignore
 function TArray(schema, references) {
-    return (0, type_1.TTransform)(schema) || Visit(schema.items, references);
+    return (0, type_1.IsTransform)(schema) || Visit(schema.items, references);
 }
 // prettier-ignore
 function TAsyncIterator(schema, references) {
-    return (0, type_1.TTransform)(schema) || Visit(schema.items, references);
+    return (0, type_1.IsTransform)(schema) || Visit(schema.items, references);
 }
 // prettier-ignore
 function TConstructor(schema, references) {
-    return (0, type_1.TTransform)(schema) || Visit(schema.returns, references) || schema.parameters.some((schema) => Visit(schema, references));
+    return (0, type_1.IsTransform)(schema) || Visit(schema.returns, references) || schema.parameters.some((schema) => Visit(schema, references));
 }
 // prettier-ignore
 function TFunction(schema, references) {
-    return (0, type_1.TTransform)(schema) || Visit(schema.returns, references) || schema.parameters.some((schema) => Visit(schema, references));
+    return (0, type_1.IsTransform)(schema) || Visit(schema.returns, references) || schema.parameters.some((schema) => Visit(schema, references));
 }
 // prettier-ignore
 function TIntersect(schema, references) {
-    return (0, type_1.TTransform)(schema) || (0, type_1.TTransform)(schema.unevaluatedProperties) || schema.allOf.some((schema) => Visit(schema, references));
+    return (0, type_1.IsTransform)(schema) || (0, type_1.IsTransform)(schema.unevaluatedProperties) || schema.allOf.some((schema) => Visit(schema, references));
 }
 // prettier-ignore
 function TIterator(schema, references) {
-    return (0, type_1.TTransform)(schema) || Visit(schema.items, references);
+    return (0, type_1.IsTransform)(schema) || Visit(schema.items, references);
 }
 // prettier-ignore
 function TNot(schema, references) {
-    return (0, type_1.TTransform)(schema) || Visit(schema.not, references);
+    return (0, type_1.IsTransform)(schema) || Visit(schema.not, references);
 }
 // prettier-ignore
 function TObject(schema, references) {
-    return ((0, type_1.TTransform)(schema) ||
+    return ((0, type_1.IsTransform)(schema) ||
         Object.values(schema.properties).some((schema) => Visit(schema, references)) ||
-        ((0, type_1.TSchema)(schema.additionalProperties) && Visit(schema.additionalProperties, references)));
+        ((0, type_1.IsSchema)(schema.additionalProperties) && Visit(schema.additionalProperties, references)));
 }
 // prettier-ignore
 function TPromise(schema, references) {
-    return (0, type_1.TTransform)(schema) || Visit(schema.item, references);
+    return (0, type_1.IsTransform)(schema) || Visit(schema.item, references);
 }
 // prettier-ignore
 function TRecord(schema, references) {
     const pattern = Object.getOwnPropertyNames(schema.patternProperties)[0];
     const property = schema.patternProperties[pattern];
-    return (0, type_1.TTransform)(schema) || Visit(property, references) || ((0, type_1.TSchema)(schema.additionalProperties) && (0, type_1.TTransform)(schema.additionalProperties));
+    return (0, type_1.IsTransform)(schema) || Visit(property, references) || ((0, type_1.IsSchema)(schema.additionalProperties) && (0, type_1.IsTransform)(schema.additionalProperties));
 }
 // prettier-ignore
 function TRef(schema, references) {
-    if ((0, type_1.TTransform)(schema))
+    if ((0, type_1.IsTransform)(schema))
         return true;
-    return Visit((0, index_2.Deref)(schema, references), references);
+    return Visit((0, index_1.Deref)(schema, references), references);
 }
 // prettier-ignore
 function TThis(schema, references) {
-    if ((0, type_1.TTransform)(schema))
+    if ((0, type_1.IsTransform)(schema))
         return true;
-    return Visit((0, index_2.Deref)(schema, references), references);
+    return Visit((0, index_1.Deref)(schema, references), references);
 }
 // prettier-ignore
 function TTuple(schema, references) {
-    return (0, type_1.TTransform)(schema) || (!(0, index_1.IsUndefined)(schema.items) && schema.items.some((schema) => Visit(schema, references)));
+    return (0, type_1.IsTransform)(schema) || (!(0, index_3.IsUndefined)(schema.items) && schema.items.some((schema) => Visit(schema, references)));
 }
 // prettier-ignore
 function TUnion(schema, references) {
-    return (0, type_1.TTransform)(schema) || schema.anyOf.some((schema) => Visit(schema, references));
+    return (0, type_1.IsTransform)(schema) || schema.anyOf.some((schema) => Visit(schema, references));
 }
 // prettier-ignore
 function Visit(schema, references) {
-    const references_ = (0, index_1.IsString)(schema.$id) ? [...references, schema] : references;
+    const references_ = (0, index_3.IsString)(schema.$id) ? [...references, schema] : references;
     const schema_ = schema;
     if (schema.$id && visited.has(schema.$id))
         return false;
     if (schema.$id)
         visited.add(schema.$id);
-    switch (schema[index_3.Kind]) {
+    switch (schema[index_2.Kind]) {
         case 'Array':
             return TArray(schema_, references_);
         case 'AsyncIterator':
@@ -108,7 +114,7 @@ function Visit(schema, references) {
         case 'Union':
             return TUnion(schema_, references_);
         default:
-            return (0, type_1.TTransform)(schema);
+            return (0, type_1.IsTransform)(schema);
     }
 }
 const visited = new Set();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinclair/typebox",
-  "version": "0.32.0-dev-18",
+  "version": "0.32.0-dev-19",
   "description": "Json Schema Type Builder with Static Type Resolution for TypeScript",
   "keywords": [
     "typescript",

package/readme.md

@@ -1136,16 +1136,16 @@ type S = Static<typeof T>                            // type S = 'A' | 'B' | 'C'
 
 ### TypeGuard
 
-TypeBox can type check its own types with the TypeGuard module. This module is written for reflection and provides structural tests for every built-in TypeBox type. Functions of this module return `is` guards which can be used with TypeScript control flow assertions to obtain schema inference. The following guards that the value A is TString.
+TypeBox can type check its own types with the TypeGuard module. This module is written for reflection and provides structural tests for every built-in TypeBox type. Functions of this module return `is` guards which can be used with TypeScript control flow assertions to obtain schema inference. The following guards that the value `T` is TString.
 
 ```typescript
-import { Type, TypeGuard } from '@sinclair/typebox'
+import { TypeGuard, Kind } from '@sinclair/typebox'
 
-const A: unknown = { ... }
+const T: unknown = { [Kind]: 'String', type: 'string' }
 
-if(TypeGuard.TString(A)) {
+if(TypeGuard.IsString(T)) {
 
-  A.type                                             // A.type = 'string'
+  // T is TString
 }
 ```