@sinclair/typebox 0.30.0-dev-1 → 0.30.0-dev-2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinclair/typebox",
-  "version": "0.30.0-dev-1",
+  "version": "0.30.0-dev-2",
   "description": "JSONSchema Type Builder with Static Type Resolution for TypeScript",
   "keywords": [
     "typescript",

package/value/cast.d.ts

@@ -24,8 +24,7 @@ export declare class ValueCastDereferenceError extends Error {
     readonly schema: Types.TRef | Types.TThis;
     constructor(schema: Types.TRef | Types.TThis);
 }
-export declare function Visit(schema: Types.TSchema, references: Types.TSchema[], value: any): any;
-/** Casts a value into a given type. The return value will retain as much information of the original value as possible. */
+/** Casts a value into a given type and references. The return value will retain as much information of the original value as possible. */
 export declare function Cast<T extends Types.TSchema>(schema: T, references: Types.TSchema[], value: unknown): Types.Static<T>;
 /** Casts a value into a given type. The return value will retain as much information of the original value as possible. */
 export declare function Cast<T extends Types.TSchema>(schema: T, value: unknown): Types.Static<T>;

package/value/cast.js

@@ -27,7 +27,7 @@ THE SOFTWARE.
 
 ---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cast = exports.Visit = exports.ValueCastDereferenceError = exports.ValueCastUnknownTypeError = exports.ValueCastRecursiveTypeError = exports.ValueCastNeverTypeError = exports.ValueCastArrayUniqueItemsTypeError = exports.ValueCastReferenceTypeError = void 0;
+exports.Cast = exports.ValueCastDereferenceError = exports.ValueCastUnknownTypeError = exports.ValueCastRecursiveTypeError = exports.ValueCastNeverTypeError = exports.ValueCastArrayUniqueItemsTypeError = exports.ValueCastReferenceTypeError = void 0;
 const Types = require("../typebox");
 const ValueCreate = require("./create");
 const ValueCheck = require("./check");
@@ -359,7 +359,6 @@ function Visit(schema, references, value) {
             return TKind(schema_, references_, value);
     }
 }
-exports.Visit = Visit;
 /** Casts a value into a given type. The return value will retain as much information of the original value as possible. */
 function Cast(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);

package/value/convert.d.ts

@@ -7,8 +7,7 @@ export declare class ValueConvertDereferenceError extends Error {
     readonly schema: Types.TRef | Types.TThis;
     constructor(schema: Types.TRef | Types.TThis);
 }
-export declare function Visit(schema: Types.TSchema, references: Types.TSchema[], value: any): unknown;
-/** Converts any type mismatched values to their target type if a conversion is possible. */
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
 export declare function Convert<T extends Types.TSchema>(schema: T, references: Types.TSchema[], value: unknown): unknown;
-/** Converts any type mismatched values to their target type if a conversion is possible. */
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
 export declare function Convert<T extends Types.TSchema>(schema: T, value: unknown): unknown;

package/value/convert.js

@@ -27,7 +27,7 @@ THE SOFTWARE.
 
 ---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Convert = exports.Visit = exports.ValueConvertDereferenceError = exports.ValueConvertUnknownTypeError = void 0;
+exports.Convert = exports.ValueConvertDereferenceError = exports.ValueConvertUnknownTypeError = void 0;
 const Types = require("../typebox");
 const ValueClone = require("./clone");
 const ValueCheck = require("./check");
@@ -351,8 +351,7 @@ function Visit(schema, references, value) {
             return TUserDefined(schema_, references_, value);
     }
 }
-exports.Visit = Visit;
-/** Converts any type mismatched values to their target type if a conversion is possible. */
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
 function Convert(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/value/create.d.ts

@@ -28,9 +28,7 @@ export declare class ValueCreateRecursiveInstantiationError extends Error {
     readonly recursiveMaxDepth: number;
     constructor(schema: Types.TSchema, recursiveMaxDepth: number);
 }
-/** Creates a value from the given schema. If the schema specifies a default value, then that value is returned. */
-export declare function Visit(schema: Types.TSchema, references: Types.TSchema[]): unknown;
-/** Creates a value from the given schema */
+/** Creates a value from the given schema and references */
 export declare function Create<T extends Types.TSchema>(schema: T, references: Types.TSchema[]): Types.Static<T>;
 /** Creates a value from the given schema */
-export declare function Create<T extends Types.TSchema>(schema: T, value: unknown): Types.Static<T>;
+export declare function Create<T extends Types.TSchema>(schema: T): Types.Static<T>;

package/value/create.js

@@ -27,7 +27,7 @@ THE SOFTWARE.
 
 ---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Create = exports.Visit = exports.ValueCreateRecursiveInstantiationError = exports.ValueCreateDereferenceError = exports.ValueCreateTempateLiteralTypeError = exports.ValueCreateIntersectTypeError = exports.ValueCreateNotTypeError = exports.ValueCreateNeverTypeError = exports.ValueCreateUnknownTypeError = void 0;
+exports.Create = exports.ValueCreateRecursiveInstantiationError = exports.ValueCreateDereferenceError = exports.ValueCreateTempateLiteralTypeError = exports.ValueCreateIntersectTypeError = exports.ValueCreateNotTypeError = exports.ValueCreateNeverTypeError = exports.ValueCreateUnknownTypeError = void 0;
 const Types = require("../typebox");
 const ValueCheck = require("./check");
 const ValueGuard = require("./guard");
@@ -431,7 +431,6 @@ function TKind(schema, references) {
         throw new Error('ValueCreate: User defined types must specify a default value');
     }
 }
-/** Creates a value from the given schema. If the schema specifies a default value, then that value is returned. */
 function Visit(schema, references) {
     const references_ = ValueGuard.IsString(schema.$id) ? [...references, schema] : references;
     const schema_ = schema;
@@ -502,7 +501,6 @@ function Visit(schema, references) {
             return TKind(schema_, references_);
     }
 }
-exports.Visit = Visit;
 // --------------------------------------------------------------------------
 // State
 // --------------------------------------------------------------------------

package/value/mutate.d.ts

@@ -7,5 +7,5 @@ export declare class ValueMutateInvalidRootMutationError extends Error {
 export type Mutable = {
     [key: string]: unknown;
 } | unknown[];
-/** Performs a deep mutable value assignment while retaining internal references. */
+/** Performs a deep mutable value assignment while retaining internal references */
 export declare function Mutate(current: Mutable, next: Mutable): void;

package/value/mutate.js

@@ -118,7 +118,7 @@ function IsMismatchedValue(current, next) {
 // --------------------------------------------------------------------------
 // Mutate
 // --------------------------------------------------------------------------
-/** Performs a deep mutable value assignment while retaining internal references. */
+/** Performs a deep mutable value assignment while retaining internal references */
 function Mutate(current, next) {
     if (IsNonMutableValue(current) || IsNonMutableValue(next))
         throw new ValueMutateInvalidRootMutationError();

package/value/value.d.ts

@@ -8,17 +8,17 @@ export declare namespace Value {
     function Cast<T extends Types.TSchema>(schema: T, references: Types.TSchema[], value: unknown): Types.Static<T>;
     /** Casts a value into a given type. The return value will retain as much information of the original value as possible. */
     function Cast<T extends Types.TSchema>(schema: T, value: unknown): Types.Static<T>;
-    /** Creates a value from the given type */
+    /** Creates a value from the given type and references */
     function Create<T extends Types.TSchema>(schema: T, references: Types.TSchema[]): Types.Static<T>;
     /** Creates a value from the given type */
     function Create<T extends Types.TSchema>(schema: T): Types.Static<T>;
-    /** Returns true if the value matches the given type. */
+    /** Returns true if the value matches the given type and references */
     function Check<T extends Types.TSchema>(schema: T, references: Types.TSchema[], value: unknown): value is Types.Static<T>;
-    /** Returns true if the value matches the given type. */
+    /** Returns true if the value matches the given type */
     function Check<T extends Types.TSchema>(schema: T, value: unknown): value is Types.Static<T>;
-    /** Converts any type mismatched values to their target type if a conversion is possible. */
+    /** Converts any type mismatched values to their target type if a reasonable conversion is possible */
     function Convert<T extends Types.TSchema>(schema: T, references: Types.TSchema[], value: unknown): unknown;
-    /** Converts any type mismatched values to their target type if a conversion is possible. */
+    /** Converts any type mismatched values to their target type if a reasonable conversion is possibl. */
     function Convert<T extends Types.TSchema>(schema: T, value: unknown): unknown;
     /** Returns a structural clone of the given value */
     function Clone<T>(value: T): T;

package/value/value.js

@@ -51,12 +51,12 @@ var Value;
         return ValueCreate.Create.apply(ValueCreate, args);
     }
     Value.Create = Create;
-    /** Returns true if the value matches the given type. */
+    /** Returns true if the value matches the given type */
     function Check(...args) {
         return ValueCheck.Check.apply(ValueCheck, args);
     }
     Value.Check = Check;
-    /** Converts any type mismatched values to their target type if a conversion is possible. */
+    /** Converts any type mismatched values to their target type if a reasonable conversion is possible */
     function Convert(...args) {
         return ValueConvert.Convert.apply(ValueConvert, args);
     }