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

package/build/require/type/type/json.js

@@ -1,4 +1,5 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonTypeBuilder = void 0;
 const index_1 = require("../any/index");
@@ -42,136 +43,190 @@ const index_38 = require("../tuple/index");
 const index_39 = require("../union/index");
 const index_40 = require("../unknown/index");
 const index_41 = require("../unsafe/index");
+/** Json Type Builder with Static Resolution for TypeScript */
 class JsonTypeBuilder {
+    // ------------------------------------------------------------------------
+    // Strict
+    // ------------------------------------------------------------------------
+    /** `[Json]` Omits compositing symbols from this schema */
     Strict(schema) {
         return (0, index_34.Strict)(schema);
     }
+    // ------------------------------------------------------------------------
+    // Modifiers
+    // ------------------------------------------------------------------------
+    /** `[Json]` Creates a Readonly and Optional property */
     ReadonlyOptional(schema) {
         return (0, index_28.ReadonlyOptional)(schema);
     }
+    /** `[Json]` Creates a Readonly property */
     Readonly(schema) {
         return (0, index_27.Readonly)(schema);
     }
+    /** `[Json]` Creates an Optional property */
     Optional(schema) {
         return (0, index_24.Optional)(schema);
     }
+    // ------------------------------------------------------------------------
+    // Types
+    // ------------------------------------------------------------------------
+    /** `[Json]` Creates an Any type */
     Any(options = {}) {
         return (0, index_1.Any)(options);
     }
+    /** `[Json]` Creates an Array type */
     Array(schema, options = {}) {
         return (0, index_2.Array)(schema, options);
     }
+    /** `[Json]` Creates a Boolean type */
     Boolean(options = {}) {
         return (0, index_3.Boolean)(options);
     }
+    /** `[Json]` Intrinsic function to Capitalize LiteralString types */
     Capitalize(schema, options = {}) {
         return (0, index_14.Capitalize)(schema, options);
     }
+    /** `[Json]` Creates a Composite object type */
     Composite(objects, options) {
-        return (0, index_4.Composite)(objects, options);
+        return (0, index_4.Composite)(objects, options); // (error) TS 5.4.0-dev - review TComposite implementation
     }
+    /** `[JavaScript]` Creates a readonly const type from the given value. */
     Const(value, options = {}) {
         return (0, index_5.Const)(value, options);
     }
+    /** `[Json]` Creates a dereferenced type */
     Deref(schema, references) {
         return (0, index_6.Deref)(schema, references);
     }
+    /** `[Json]` Creates a Enum type */
     Enum(item, options = {}) {
         return (0, index_7.Enum)(item, options);
     }
+    /** `[Json]` Constructs a type by excluding from unionType all union members that are assignable to excludedMembers */
     Exclude(unionType, excludedMembers, options = {}) {
         return (0, index_8.Exclude)(unionType, excludedMembers, options);
     }
+    /** `[Json]` Creates a Conditional type */
     Extends(L, R, T, F, options = {}) {
         return (0, index_9.Extends)(L, R, T, F, options);
     }
+    /** `[Json]` Constructs a type by extracting from type all union members that are assignable to union */
     Extract(type, union, options = {}) {
         return (0, index_10.Extract)(type, union, options);
     }
+    /** `[Json]` Returns an Indexed property type for the given keys */
     Index(schema, unresolved, options = {}) {
         return (0, index_11.Index)(schema, unresolved, options);
     }
+    /** `[Json]` Creates an Integer type */
     Integer(options = {}) {
         return (0, index_12.Integer)(options);
     }
+    /** `[Json]` Creates an Intersect type */
     Intersect(T, options = {}) {
         return (0, index_13.Intersect)(T, options);
     }
+    /** `[Json]` Creates a KeyOf type */
     KeyOf(schema, options = {}) {
         return (0, index_15.KeyOf)(schema, options);
     }
+    /** `[Json]` Creates a Literal type */
     Literal(value, options = {}) {
         return (0, index_16.Literal)(value, options);
     }
+    /** `[Json]` Intrinsic function to Lowercase LiteralString types */
     Lowercase(schema, options = {}) {
         return (0, index_14.Lowercase)(schema, options);
     }
+    /** `[Json]` Creates a Mapped object type */
     Mapped(key, map, options = {}) {
         return (0, index_17.Mapped)(key, map, options);
     }
+    /** `[Json]` Creates a Never type */
     Never(options = {}) {
         return (0, index_18.Never)(options);
     }
+    /** `[Json]` Creates a Not type */
     Not(schema, options) {
         return (0, index_19.Not)(schema, options);
     }
+    /** `[Json]` Creates a Null type */
     Null(options = {}) {
         return (0, index_20.Null)(options);
     }
+    /** `[Json]` Creates a Number type */
     Number(options = {}) {
         return (0, index_21.Number)(options);
     }
+    /** `[Json]` Creates an Object type */
     Object(properties, options = {}) {
         return (0, index_22.Object)(properties, options);
     }
+    /** `[Json]` Constructs a type whose keys are omitted from the given type */
     Omit(schema, unresolved, options = {}) {
         return (0, index_23.Omit)(schema, unresolved, options);
     }
+    /** `[Json]` Constructs a type where all properties are optional */
     Partial(schema, options = {}) {
         return (0, index_25.Partial)(schema, options);
     }
+    /** `[Json]` Constructs a type whose keys are picked from the given type */
     Pick(schema, unresolved, options = {}) {
         return (0, index_26.Pick)(schema, unresolved, options);
     }
+    /** `[Json]` Creates a Record type */
     Record(key, schema, options = {}) {
         return (0, index_29.Record)(key, schema);
     }
+    /** `[Json]` Creates a Recursive type */
     Recursive(callback, options = {}) {
         return (0, index_30.Recursive)(callback, options);
     }
+    /** `[Json]` Creates a Ref type. */
     Ref(unresolved, options = {}) {
         return (0, index_31.Ref)(unresolved, options);
     }
+    /** `[Json]` Constructs a type where all properties are required */
     Required(schema, options = {}) {
         return (0, index_32.Required)(schema, options);
     }
+    /** `[Json]` Extracts interior Rest elements from Tuple, Intersect and Union types */
     Rest(schema) {
         return (0, index_33.Rest)(schema);
     }
+    /** `[Json]` Creates a String type */
     String(options = {}) {
         return (0, index_35.String)(options);
     }
+    /** `[Json]` Creates a TemplateLiteral type */
     TemplateLiteral(unresolved, options = {}) {
         return (0, index_36.TemplateLiteral)(unresolved, options);
     }
+    /** `[Json]` Creates a Transform type */
     Transform(schema) {
         return (0, index_37.Transform)(schema);
     }
+    /** `[Json]` Creates a Tuple type */
     Tuple(items, options = {}) {
         return (0, index_38.Tuple)(items, options);
     }
+    /** `[Json]` Intrinsic function to Uncapitalize LiteralString types */
     Uncapitalize(schema, options = {}) {
         return (0, index_14.Uncapitalize)(schema, options);
     }
+    /** `[Json]` Creates a Union type */
     Union(schemas, options = {}) {
         return (0, index_39.Union)(schemas, options);
     }
+    /** `[Json]` Creates an Unknown type */
     Unknown(options = {}) {
         return (0, index_40.Unknown)(options);
     }
+    /** `[Json]` Creates a Unsafe type that will infers as the generic argument T */
     Unsafe(options = {}) {
         return (0, index_41.Unsafe)(options);
     }
+    /** `[Json]` Intrinsic function to Uppercase LiteralString types */
     Uppercase(schema, options = {}) {
         return (0, index_14.Uppercase)(schema, options);
     }

package/build/require/type/type/type.js

@@ -1,7 +1,11 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Strict = exports.ReturnType = exports.Rest = exports.Required = exports.RegExp = exports.Ref = exports.Recursive = exports.Record = exports.ReadonlyOptional = exports.Readonly = exports.Promise = exports.Pick = exports.Partial = exports.Parameters = exports.Optional = exports.Omit = exports.Object = exports.Number = exports.Null = exports.Not = exports.Never = exports.Mapped = exports.Literal = exports.KeyOf = exports.Iterator = exports.Uppercase = exports.Lowercase = exports.Uncapitalize = exports.Capitalize = exports.Intersect = exports.Integer = exports.InstanceType = exports.Index = exports.Function = exports.Extract = exports.Extends = exports.Exclude = exports.Enum = exports.Deref = exports.Date = exports.ConstructorParameters = exports.Constructor = exports.Const = exports.Composite = exports.Boolean = exports.BigInt = exports.Awaited = exports.AsyncIterator = exports.Array = exports.Any = void 0;
 exports.Void = exports.Unsafe = exports.Unknown = exports.Union = exports.Undefined = exports.Uint8Array = exports.Tuple = exports.Transform = exports.TemplateLiteral = exports.Symbol = exports.String = void 0;
+// ------------------------------------------------------------------
+// Type: Module
+// ------------------------------------------------------------------
 var index_1 = require("../any/index");
 Object.defineProperty(exports, "Any", { enumerable: true, get: function () { return index_1.Any; } });
 var index_2 = require("../array/index");

package/build/require/type/uint8array/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/type/uint8array/uint8array.d.ts

@@ -9,4 +9,5 @@ export interface TUint8Array extends TSchema, Uint8ArrayOptions {
     static: Uint8Array;
     type: 'uint8array';
 }
+/** `[JavaScript]` Creates a Uint8Array type */
 export declare function Uint8Array(options?: Uint8ArrayOptions): TUint8Array;

package/build/require/type/uint8array/uint8array.js

@@ -1,7 +1,9 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Uint8Array = void 0;
 const index_1 = require("../symbols/index");
+/** `[JavaScript]` Creates a Uint8Array type */
 function Uint8Array(options = {}) {
     return { ...options, [index_1.Kind]: 'Uint8Array', type: 'Uint8Array' };
 }

package/build/require/type/undefined/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/type/undefined/undefined.d.ts

@@ -5,4 +5,5 @@ export interface TUndefined extends TSchema {
     static: undefined;
     type: 'undefined';
 }
+/** `[JavaScript]` Creates a Undefined type */
 export declare function Undefined(options?: SchemaOptions): TUndefined;

package/build/require/type/undefined/undefined.js

@@ -1,7 +1,9 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Undefined = void 0;
 const index_1 = require("../symbols/index");
+/** `[JavaScript]` Creates a Undefined type */
 function Undefined(options = {}) {
     return { ...options, [index_1.Kind]: 'Undefined', type: 'undefined' };
 }

package/build/require/type/union/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/type/union/union-create.js

@@ -1,4 +1,5 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnionCreate = void 0;
 const type_1 = require("../clone/type");

package/build/require/type/union/union-evaluated.d.ts

@@ -12,5 +12,6 @@ declare function RemoveOptionalFromType<T extends TSchema>(T: T): RemoveOptional
 type ResolveUnion<T extends TSchema[], R extends TSchema[] = RemoveOptionalFromRest<T>> = (IsUnionOptional<T> extends true ? TOptional<TUnion<R>> : TUnion<R>);
 declare function ResolveUnion<T extends TSchema[]>(T: T, options: SchemaOptions): ResolveUnion<T>;
 export type UnionEvaluated<T extends TSchema[]> = (T extends [] ? TNever : T extends [TSchema] ? T[0] : ResolveUnion<T>);
+/** `[Json]` Creates an evaluated Union type */
 export declare function UnionEvaluated<T extends TSchema[], R = UnionEvaluated<T>>(T: [...T], options?: SchemaOptions): R;
 export {};

package/build/require/type/union/union-evaluated.js

@@ -1,4 +1,5 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnionEvaluated = void 0;
 const index_1 = require("../symbols/index");
@@ -7,7 +8,12 @@ const index_2 = require("../discard/index");
 const index_3 = require("../never/index");
 const index_4 = require("../optional/index");
 const union_create_1 = require("./union-create");
+// ------------------------------------------------------------------
+// TypeGuard
+// ------------------------------------------------------------------
+// prettier-ignore
 const type_2 = require("../guard/type");
+// prettier-ignore
 function IsUnionOptional(T) {
     const [L, ...R] = T;
     return (T.length > 0
@@ -16,18 +22,23 @@ function IsUnionOptional(T) {
             : IsUnionOptional(R)
         : false);
 }
+// prettier-ignore
 function RemoveOptionalFromRest(T) {
     return (T.map(T => RemoveOptionalFromType(T)));
 }
+// prettier-ignore
 function RemoveOptionalFromType(T) {
     return ((0, index_2.Discard)(T, [index_1.OptionalKind]));
 }
+// prettier-ignore
 function ResolveUnion(T, options) {
     return (IsUnionOptional(T)
         ? (0, index_4.Optional)((0, union_create_1.UnionCreate)(RemoveOptionalFromRest(T), options))
         : (0, union_create_1.UnionCreate)(RemoveOptionalFromRest(T), options));
 }
+/** `[Json]` Creates an evaluated Union type */
 function UnionEvaluated(T, options = {}) {
+    // prettier-ignore
     return (T.length === 0 ? (0, index_3.Never)(options) :
         T.length === 1 ? (0, type_1.CloneType)(T[0], options) :
             ResolveUnion(T, options));

package/build/require/type/union/union-type.js

@@ -1,3 +1,4 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("../symbols/index");

package/build/require/type/union/union.d.ts

@@ -2,4 +2,5 @@ import type { TSchema, SchemaOptions } from '../schema/index';
 import { type TNever } from '../never/index';
 import type { TUnion } from './union-type';
 export type Union<T extends TSchema[]> = (T extends [] ? TNever : T extends [TSchema] ? T[0] : TUnion<T>);
+/** `[Json]` Creates a Union type */
 export declare function Union<T extends TSchema[]>(T: [...T], options?: SchemaOptions): Union<T>;

package/build/require/type/union/union.js

@@ -1,10 +1,13 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Union = void 0;
 const index_1 = require("../never/index");
 const type_1 = require("../clone/type");
 const union_create_1 = require("./union-create");
+/** `[Json]` Creates a Union type */
 function Union(T, options = {}) {
+    // prettier-ignore
     return (T.length === 0 ? (0, index_1.Never)(options) :
         T.length === 1 ? (0, type_1.CloneType)(T[0], options) :
             (0, union_create_1.UnionCreate)(T, options));

package/build/require/type/unknown/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/type/unknown/unknown.d.ts

@@ -4,4 +4,5 @@ export interface TUnknown extends TSchema {
     [Kind]: 'Unknown';
     static: unknown;
 }
+/** `[Json]` Creates an Unknown type */
 export declare function Unknown(options?: SchemaOptions): TUnknown;

package/build/require/type/unknown/unknown.js

@@ -1,7 +1,9 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Unknown = void 0;
 const index_1 = require("../symbols/index");
+/** `[Json]` Creates an Unknown type */
 function Unknown(options = {}) {
     return {
         ...options,

package/build/require/type/unsafe/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/type/unsafe/unsafe.d.ts

@@ -7,4 +7,5 @@ export interface TUnsafe<T> extends TSchema {
     [Kind]: string;
     static: T;
 }
+/** `[Json]` Creates a Unsafe type that will infers as the generic argument T */
 export declare function Unsafe<T>(options?: UnsafeOptions): TUnsafe<T>;

package/build/require/type/unsafe/unsafe.js

@@ -1,7 +1,9 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Unsafe = void 0;
 const index_1 = require("../symbols/index");
+/** `[Json]` Creates a Unsafe type that will infers as the generic argument T */
 function Unsafe(options = {}) {
     return {
         ...options,

package/build/require/type/void/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/type/void/void.d.ts

@@ -5,4 +5,5 @@ export interface TVoid extends TSchema {
     static: void;
     type: 'void';
 }
+/** `[JavaScript]` Creates a Void type */
 export declare function Void(options?: SchemaOptions): TVoid;

package/build/require/type/void/void.js

@@ -1,7 +1,9 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Void = void 0;
 const index_1 = require("../symbols/index");
+/** `[JavaScript]` Creates a Void type */
 function Void(options = {}) {
     return {
         ...options,

package/build/require/value/cast/cast.d.ts

@@ -17,5 +17,7 @@ export declare class ValueCastUnknownTypeError extends Error {
     readonly schema: TSchema;
     constructor(schema: TSchema);
 }
+/** 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 TSchema>(schema: T, references: TSchema[], value: unknown): 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 TSchema>(schema: T, value: unknown): Static<T>;

package/build/require/value/cast/cast.js

@@ -1,4 +1,5 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cast = exports.ValueCastUnknownTypeError = exports.ValueCastRecursiveTypeError = exports.ValueCastNeverTypeError = exports.ValueCastArrayUniqueItemsTypeError = void 0;
 const index_1 = require("../guard/index");
@@ -7,6 +8,9 @@ const index_3 = require("../create/index");
 const index_4 = require("../check/index");
 const index_5 = require("../clone/index");
 const index_6 = require("../deref/index");
+// ------------------------------------------------------------------
+// Errors
+// ------------------------------------------------------------------
 class ValueCastArrayUniqueItemsTypeError extends Error {
     constructor(schema, value) {
         super('Array cast produced invalid data due to uniqueItems constraint');
@@ -36,6 +40,14 @@ class ValueCastUnknownTypeError extends Error {
     }
 }
 exports.ValueCastUnknownTypeError = ValueCastUnknownTypeError;
+// ------------------------------------------------------------------
+// The following will score a schema against a value. For objects,
+// the score is the tally of points awarded for each property of
+// the value. Property points are (1.0 / propertyCount) to prevent
+// large property counts biasing results. Properties that match
+// literal values are maximally awarded as literals are typically
+// used as union discriminator fields.
+// ------------------------------------------------------------------
 function ScoreUnion(schema, references, value) {
     if (schema[index_2.Kind] === 'Object' && typeof value === 'object' && !(0, index_1.IsNull)(value)) {
         const object = schema;
@@ -73,12 +85,18 @@ function CastUnion(union, references, value) {
         return Cast(schema, references, value);
     }
 }
+// ------------------------------------------------------------------
+// Default
+// ------------------------------------------------------------------
 function DefaultClone(schema, references, value) {
     return (0, index_4.Check)(schema, references, value) ? (0, index_5.Clone)(value) : (0, index_3.Create)(schema, references);
 }
 function Default(schema, references, value) {
     return (0, index_4.Check)(schema, references, value) ? value : (0, index_3.Create)(schema, references);
 }
+// ------------------------------------------------------------------
+// Cast
+// ------------------------------------------------------------------
 function TArray(schema, references, value) {
     if ((0, index_4.Check)(schema, references, value))
         return (0, index_5.Clone)(value);
@@ -125,6 +143,7 @@ function TObject(schema, references, value) {
             continue;
         result[key] = Visit(property, references, value[key]);
     }
+    // additional schema properties
     if (typeof schema.additionalProperties === 'object') {
         const propertyNames = Object.getOwnPropertyNames(schema.properties);
         for (const propertyName of Object.getOwnPropertyNames(value)) {
@@ -170,6 +189,9 @@ function Visit(schema, references, value) {
     const references_ = (0, index_1.IsString)(schema.$id) ? [...references, schema] : references;
     const schema_ = schema;
     switch (schema[index_2.Kind]) {
+        // --------------------------------------------------------------
+        // Structural
+        // --------------------------------------------------------------
         case 'Array':
             return TArray(schema_, references_, value);
         case 'Constructor':
@@ -190,14 +212,21 @@ function Visit(schema, references, value) {
             return TTuple(schema_, references_, value);
         case 'Union':
             return TUnion(schema_, references_, value);
+        // --------------------------------------------------------------
+        // DefaultClone
+        // --------------------------------------------------------------
         case 'Date':
         case 'Symbol':
         case 'Uint8Array':
             return DefaultClone(schema, references, value);
+        // --------------------------------------------------------------
+        // Default
+        // --------------------------------------------------------------
         default:
             return Default(schema_, references_, value);
     }
 }
+/** 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/build/require/value/cast/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/value/check/check.d.ts

@@ -4,5 +4,7 @@ export declare class ValueCheckUnknownTypeError extends Error {
     readonly schema: TSchema;
     constructor(schema: TSchema);
 }
+/** Returns true if the value matches the given type. */
 export declare function Check<T extends TSchema>(schema: T, references: TSchema[], value: unknown): value is Static<T>;
+/** Returns true if the value matches the given type. */
 export declare function Check<T extends TSchema>(schema: T, value: unknown): value is Static<T>;

package/build/require/value/check/check.js

@@ -1,4 +1,5 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Check = exports.ValueCheckUnknownTypeError = void 0;
 const index_1 = require("../guard/index");
@@ -11,6 +12,9 @@ const index_7 = require("../../type/extends/index");
 const type_1 = require("../../type/guard/type");
 const index_8 = require("../../type/registry/index");
 const index_9 = require("../../type/never/index");
+// --------------------------------------------------------------------------
+// Errors
+// --------------------------------------------------------------------------
 class ValueCheckUnknownTypeError extends Error {
     constructor(schema) {
         super(`Unknown type`);
@@ -18,12 +22,21 @@ class ValueCheckUnknownTypeError extends Error {
     }
 }
 exports.ValueCheckUnknownTypeError = ValueCheckUnknownTypeError;
+// --------------------------------------------------------------------------
+// TypeGuards
+// --------------------------------------------------------------------------
 function IsAnyOrUnknown(schema) {
     return schema[index_5.Kind] === 'Any' || schema[index_5.Kind] === 'Unknown';
 }
+// --------------------------------------------------------------------------
+// Guards
+// --------------------------------------------------------------------------
 function IsDefined(value) {
     return value !== undefined;
 }
+// --------------------------------------------------------------------------
+// Types
+// --------------------------------------------------------------------------
 function TAny(schema, references, value) {
     return true;
 }
@@ -39,6 +52,7 @@ function TArray(schema, references, value) {
     if (!value.every((value) => Visit(schema.items, references, value))) {
         return false;
     }
+    // prettier-ignore
     if (schema.uniqueItems === true && !((function () { const set = new Set(); for (const element of value) {
         const hashed = (0, index_4.Hash)(element);
         if (set.has(hashed)) {
@@ -50,8 +64,9 @@ function TArray(schema, references, value) {
     } return true; })())) {
         return false;
     }
+    // contains
     if (!(IsDefined(schema.contains) || (0, index_1.IsNumber)(schema.minContains) || (0, index_1.IsNumber)(schema.maxContains))) {
-        return true;
+        return true; // exit
     }
     const containsSchema = IsDefined(schema.contains) ? schema.contains : (0, index_9.Never)();
     const containsCount = value.reduce((acc, value) => (Visit(containsSchema, references, value) ? acc + 1 : acc), 0);
@@ -218,6 +233,7 @@ function TObject(schema, references, value) {
     }
     if (schema.additionalProperties === false) {
         const valueKeys = Object.getOwnPropertyNames(value);
+        // optimization: value is valid if schemaKey length matches the valueKey length
         if (schema.required && schema.required.length === knownKeys.length && valueKeys.length === knownKeys.length) {
             return true;
         }
@@ -248,9 +264,11 @@ function TRecord(schema, references, value) {
     }
     const [patternKey, patternSchema] = Object.entries(schema.patternProperties)[0];
     const regex = new RegExp(patternKey);
+    // prettier-ignore
     const check1 = Object.entries(value).every(([key, value]) => {
         return (regex.test(key)) ? Visit(patternSchema, references, value) : true;
     });
+    // prettier-ignore
     const check2 = typeof schema.additionalProperties === 'object' ? Object.entries(value).every(([key, value]) => {
         return (!regex.test(key)) ? Visit(schema.additionalProperties, references, value) : true;
     }) : true;
@@ -417,6 +435,7 @@ function Visit(schema, references, value) {
             return TKind(schema_, references_, value);
     }
 }
+/** Returns true if the value matches the given type. */
 function Check(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/build/require/value/check/index.js

@@ -1,4 +1,5 @@
 "use strict";
+
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/value/clean/clean.d.ts

@@ -1,3 +1,5 @@
 import type { TSchema } from '../../type/schema/index';
+/** `[Mutable]` Removes excess properties from a value and returns the result. This function does not check the value and returns an unknown type. You should Check the result before use. Clean is a mutable operation. To avoid mutation, Clone the value first. */
 export declare function Clean<T extends TSchema>(schema: T, references: TSchema[], value: unknown): unknown;
+/** `[Mutable]` Removes excess properties from a value and returns the result. This function does not check the value and returns an unknown type. You should Check the result before use. Clean is a mutable operation. To avoid mutation, Clone the value first. */
 export declare function Clean<T extends TSchema>(schema: T): unknown;