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

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

@@ -17,23 +17,42 @@ import { type TSymbol } from '../symbol/index';
 import { type TUint8Array, type Uint8ArrayOptions } from '../uint8array/index';
 import { type TUndefined } from '../undefined/index';
 import { type TVoid } from '../void/index';
+/** JavaScript Type Builder with Static Resolution for TypeScript */
 export declare class JavaScriptTypeBuilder extends JsonTypeBuilder {
+    /** `[JavaScript]` Creates a AsyncIterator type */
     AsyncIterator<T extends TSchema>(items: T, options?: SchemaOptions): TAsyncIterator<T>;
+    /** `[JavaScript]` Constructs a type by recursively unwrapping Promise types */
     Awaited<T extends TSchema>(schema: T, options?: SchemaOptions): TAwaited<T>;
+    /** `[JavaScript]` Creates a BigInt type */
     BigInt(options?: BigIntOptions): TBigInt;
+    /** `[JavaScript]` Extracts the ConstructorParameters from the given Constructor type */
     ConstructorParameters<T extends TConstructor<TSchema[], TSchema>>(schema: T, options?: SchemaOptions): TConstructorParameters<T>;
+    /** `[JavaScript]` Creates a Constructor type */
     Constructor<T extends TSchema[], U extends TSchema>(parameters: [...T], returns: U, options?: SchemaOptions): TConstructor<T, U>;
+    /** `[JavaScript]` Creates a Date type */
     Date(options?: DateOptions): TDate;
+    /** `[JavaScript]` Creates a Function type */
     Function<T extends TSchema[], U extends TSchema>(parameters: [...T], returns: U, options?: SchemaOptions): TFunction<T, U>;
+    /** `[JavaScript]` Extracts the InstanceType from the given Constructor type */
     InstanceType<T extends TConstructor<any[], any>>(schema: T, options?: SchemaOptions): TInstanceType<T>;
+    /** `[JavaScript]` Creates an Iterator type */
     Iterator<T extends TSchema>(items: T, options?: SchemaOptions): TIterator<T>;
+    /** `[JavaScript]` Extracts the Parameters from the given Function type */
     Parameters<T extends TFunction<TSchema[], TSchema>>(schema: T, options?: SchemaOptions): TParameters<T>;
+    /** `[JavaScript]` Creates a Promise type */
     Promise<T extends TSchema>(item: T, options?: SchemaOptions): TPromise<T>;
+    /** `[JavaScript]` Creates a String type from a Regular Expression pattern */
     RegExp(pattern: string, options?: SchemaOptions): TRegExp;
+    /** `[JavaScript]` Creates a String type from a Regular Expression */
     RegExp(regex: RegExp, options?: SchemaOptions): TRegExp;
+    /** `[JavaScript]` Extracts the ReturnType from the given Function type */
     ReturnType<T extends TFunction<any[], any>>(schema: T, options?: SchemaOptions): TReturnType<T>;
+    /** `[JavaScript]` Creates a Symbol type */
     Symbol(options?: SchemaOptions): TSymbol;
+    /** `[JavaScript]` Creates a Undefined type */
     Undefined(options?: SchemaOptions): TUndefined;
+    /** `[JavaScript]` Creates a Uint8Array type */
     Uint8Array(options?: Uint8ArrayOptions): TUint8Array;
+    /** `[JavaScript]` Creates a Void type */
     Void(options?: SchemaOptions): TVoid;
 }

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

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JavaScriptTypeBuilder = void 0;
 const json_1 = require("./json");
@@ -19,55 +46,73 @@ const index_14 = require("../symbol/index");
 const index_15 = require("../uint8array/index");
 const index_16 = require("../undefined/index");
 const index_17 = require("../void/index");
+/** JavaScript Type Builder with Static Resolution for TypeScript */
 class JavaScriptTypeBuilder extends json_1.JsonTypeBuilder {
+    /** `[JavaScript]` Creates a AsyncIterator type */
     AsyncIterator(items, options = {}) {
         return (0, index_1.AsyncIterator)(items, options);
     }
+    /** `[JavaScript]` Constructs a type by recursively unwrapping Promise types */
     Awaited(schema, options = {}) {
         return (0, index_2.Awaited)(schema, options);
     }
+    /** `[JavaScript]` Creates a BigInt type */
     BigInt(options = {}) {
         return (0, index_3.BigInt)(options);
     }
+    /** `[JavaScript]` Extracts the ConstructorParameters from the given Constructor type */
     ConstructorParameters(schema, options = {}) {
         return (0, index_5.ConstructorParameters)(schema, options);
     }
+    /** `[JavaScript]` Creates a Constructor type */
     Constructor(parameters, returns, options) {
         return (0, index_4.Constructor)(parameters, returns, options);
     }
+    /** `[JavaScript]` Creates a Date type */
     Date(options = {}) {
         return (0, index_6.Date)(options);
     }
+    /** `[JavaScript]` Creates a Function type */
     Function(parameters, returns, options) {
         return (0, index_7.Function)(parameters, returns, options);
     }
+    /** `[JavaScript]` Extracts the InstanceType from the given Constructor type */
     InstanceType(schema, options = {}) {
         return (0, index_8.InstanceType)(schema, options);
     }
+    /** `[JavaScript]` Creates an Iterator type */
     Iterator(items, options = {}) {
         return (0, index_9.Iterator)(items, options);
     }
+    /** `[JavaScript]` Extracts the Parameters from the given Function type */
     Parameters(schema, options = {}) {
         return (0, index_10.Parameters)(schema, options);
     }
+    /** `[JavaScript]` Creates a Promise type */
     Promise(item, options = {}) {
         return (0, index_11.Promise)(item, options);
     }
+    /** `[JavaScript]` Creates a String type */
     RegExp(unresolved, options = {}) {
         return (0, index_12.RegExp)(unresolved, options);
     }
+    /** `[JavaScript]` Extracts the ReturnType from the given Function type */
     ReturnType(schema, options = {}) {
         return (0, index_13.ReturnType)(schema, options);
     }
+    /** `[JavaScript]` Creates a Symbol type */
     Symbol(options) {
         return (0, index_14.Symbol)(options);
     }
+    /** `[JavaScript]` Creates a Undefined type */
     Undefined(options = {}) {
         return (0, index_16.Undefined)(options);
     }
+    /** `[JavaScript]` Creates a Uint8Array type */
     Uint8Array(options = {}) {
         return (0, index_15.Uint8Array)(options);
     }
+    /** `[JavaScript]` Creates a Void type */
     Void(options = {}) {
         return (0, index_17.Void)(options);
     }

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

@@ -10,7 +10,7 @@ import { type TExtends, type TExtendsFromMappedKey, type TExtendsFromMappedResul
 import { type TExtract, type TExtractFromMappedResult } from '../extract/index';
 import { TIndex, type TIndexPropertyKeys, type TIndexFromMappedKey } from '../indexed/index';
 import { type IntegerOptions, type TInteger } from '../integer/index';
-import { type IntersectOptions, type IntersectResolve } from '../intersect/index';
+import { Intersect, type IntersectOptions } from '../intersect/index';
 import { type TCapitalize, type TUncapitalize, type TLowercase, type TUppercase } from '../intrinsic/index';
 import { type TKeyOf, type TKeyOfFromMappedResult } from '../keyof/index';
 import { type TLiteral, type TLiteralValue } from '../literal/index';
@@ -37,68 +37,129 @@ import { type TString, type StringOptions } from '../string/index';
 import { type TTemplateLiteral, type TTemplateLiteralKind, type TemplateLiteralSyntax } from '../template-literal/index';
 import { TransformDecodeBuilder } from '../transform/index';
 import { type TTuple } from '../tuple/index';
-import { type UnionResolve } from '../union/index';
+import { Union } from '../union/index';
 import { type TUnknown } from '../unknown/index';
 import { type TUnsafe, type UnsafeOptions } from '../unsafe/index';
+/** Json Type Builder with Static Resolution for TypeScript */
 export declare class JsonTypeBuilder {
+    /** `[Json]` Omits compositing symbols from this schema */
     Strict<T extends TSchema>(schema: T): T;
+    /** `[Json]` Creates a Readonly and Optional property */
     ReadonlyOptional<T extends TSchema>(schema: T): TReadonlyOptional<T>;
+    /** `[Json]` Creates a Readonly property */
     Readonly<T extends TSchema>(schema: T): TReadonly<T>;
+    /** `[Json]` Creates an Optional property */
     Optional<T extends TSchema>(schema: T): TOptional<T>;
+    /** `[Json]` Creates an Any type */
     Any(options?: SchemaOptions): TAny;
+    /** `[Json]` Creates an Array type */
     Array<T extends TSchema>(schema: T, options?: ArrayOptions): TArray<T>;
+    /** `[Json]` Creates a Boolean type */
     Boolean(options?: SchemaOptions): TBoolean;
+    /** `[Json]` Intrinsic function to Capitalize LiteralString types */
     Capitalize<T extends TSchema>(schema: T, options?: SchemaOptions): TCapitalize<T>;
+    /** `[Json]` Creates a Composite object type */
     Composite<T extends TObject[]>(objects: [...T], options?: ObjectOptions): TComposite<T>;
-    Const<T>(value: T, options?: SchemaOptions): TConst<T>;
+    /** `[JavaScript]` Creates a readonly const type from the given value. */
+    Const</* const (not supported in 4.0) */ T>(value: T, options?: SchemaOptions): TConst<T>;
+    /** `[Json]` Creates a dereferenced type */
     Deref<T extends TSchema>(schema: T, references: TSchema[]): TDeref<T>;
+    /** `[Json]` Creates a Enum type */
     Enum<V extends TEnumValue, T extends Record<TEnumKey, V>>(item: T, options?: SchemaOptions): TEnum<T>;
+    /** `[Json]` Constructs a type by excluding from unionType all union members that are assignable to excludedMembers */
     Exclude<L extends TMappedResult, R extends TSchema>(unionType: L, excludedMembers: R, options?: SchemaOptions): TExcludeFromMappedResult<L, R>;
+    /** `[Json]` Constructs a type by excluding from unionType all union members that are assignable to excludedMembers */
     Exclude<L extends TSchema, R extends TSchema>(unionType: L, excludedMembers: R, options?: SchemaOptions): TExclude<L, R>;
+    /** `[Json]` Creates a Conditional type */
     Extends<L extends TMappedResult, R extends TSchema, T extends TSchema, F extends TSchema>(L: L, R: R, T: T, F: F, options?: SchemaOptions): TExtendsFromMappedResult<L, R, T, F>;
+    /** `[Json]` Creates a Conditional type */
     Extends<L extends TMappedKey, R extends TSchema, T extends TSchema, F extends TSchema>(L: L, R: R, T: T, F: F, options?: SchemaOptions): TExtendsFromMappedKey<L, R, T, F>;
+    /** `[Json]` Creates a Conditional type */
     Extends<L extends TSchema, R extends TSchema, T extends TSchema, F extends TSchema>(L: L, R: R, T: T, F: F, options?: SchemaOptions): TExtends<L, R, T, F>;
+    /** `[Json]` Constructs a type by extracting from type all union members that are assignable to union */
     Extract<L extends TMappedResult, R extends TSchema>(type: L, union: R, options?: SchemaOptions): TExtractFromMappedResult<L, R>;
+    /** `[Json]` Constructs a type by extracting from type all union members that are assignable to union */
     Extract<L extends TSchema, R extends TSchema>(type: L, union: R, options?: SchemaOptions): TExtract<L, R>;
+    /** `[Json]` Returns an Indexed property type for the given keys */
     Index<T extends TSchema, K extends TMappedKey>(T: T, K: K, options?: SchemaOptions): TIndexFromMappedKey<T, K>;
+    /** `[Json]` Returns an Indexed property type for the given keys */
     Index<T extends TSchema, K extends TSchema, I extends PropertyKey[] = TIndexPropertyKeys<K>>(T: T, K: K, options?: SchemaOptions): TIndex<T, I>;
+    /** `[Json]` Returns an Indexed property type for the given keys */
     Index<T extends TSchema, K extends PropertyKey[]>(T: T, K: readonly [...K], options?: SchemaOptions): TIndex<T, K>;
+    /** `[Json]` Creates an Integer type */
     Integer(options?: IntegerOptions): TInteger;
-    Intersect<T extends TSchema[]>(T: [...T], options?: IntersectOptions): IntersectResolve<T>;
+    /** `[Json]` Creates an Intersect type */
+    Intersect<T extends TSchema[]>(T: [...T], options?: IntersectOptions): Intersect<T>;
+    /** `[Json]` Creates a KeyOf type */
     KeyOf<T extends TMappedResult>(schema: T, options?: SchemaOptions): TKeyOfFromMappedResult<T>;
+    /** `[Json]` Creates a KeyOf type */
     KeyOf<T extends TSchema>(schema: T, options?: SchemaOptions): TKeyOf<T>;
+    /** `[Json]` Creates a Literal type */
     Literal<T extends TLiteralValue>(value: T, options?: SchemaOptions): TLiteral<T>;
+    /** `[Json]` Intrinsic function to Lowercase LiteralString types */
     Lowercase<T extends TSchema>(schema: T, options?: SchemaOptions): TLowercase<T>;
+    /** `[Json]` Creates a Mapped object type */
     Mapped<K extends TSchema, I extends PropertyKey[] = TIndexPropertyKeys<K>, F extends TMappedFunction<I> = TMappedFunction<I>, R extends TMapped<I, F> = TMapped<I, F>>(key: K, map: F, options?: ObjectOptions): R;
+    /** `[Json]` Creates a Mapped object type */
     Mapped<K extends PropertyKey[], F extends TMappedFunction<K> = TMappedFunction<K>, R extends TMapped<K, F> = TMapped<K, F>>(key: [...K], map: F, options?: ObjectOptions): R;
+    /** `[Json]` Creates a Never type */
     Never(options?: SchemaOptions): TNever;
+    /** `[Json]` Creates a Not type */
     Not<T extends TSchema>(schema: T, options?: SchemaOptions): TNot<T>;
+    /** `[Json]` Creates a Null type */
     Null(options?: SchemaOptions): TNull;
+    /** `[Json]` Creates a Number type */
     Number(options?: NumberOptions): TNumber;
+    /** `[Json]` Creates an Object type */
     Object<T extends TProperties>(properties: T, options?: ObjectOptions): TObject<T>;
+    /** `[Json]` Constructs a type whose keys are omitted from the given type */
     Omit<T extends TSchema, K extends TMappedKey>(T: T, K: K): TOmitFromMappedKey<T, K>;
+    /** `[Json]` Constructs a type whose keys are omitted from the given type */
     Omit<T extends TSchema, K extends TSchema, I extends PropertyKey[] = TIndexPropertyKeys<K>>(T: T, K: K, options?: SchemaOptions): TOmit<T, I>;
+    /** `[Json]` Constructs a type whose keys are omitted from the given type */
     Omit<T extends TSchema, K extends PropertyKey[]>(T: T, K: readonly [...K], options?: SchemaOptions): TOmit<T, K>;
+    /** `[Json]` Constructs a type where all properties are optional */
     Partial<T extends TMappedResult>(T: T, options?: ObjectOptions): TPartialFromMappedResult<T>;
+    /** `[Json]` Constructs a type where all properties are optional */
     Partial<T extends TSchema>(schema: T, options?: ObjectOptions): TPartial<T>;
+    /** `[Json]` Constructs a type whose keys are picked from the given type */
     Pick<T extends TSchema, K extends TMappedKey>(T: T, K: K): TPickFromMappedKey<T, K>;
+    /** `[Json]` Constructs a type whose keys are picked from the given type */
     Pick<T extends TSchema, K extends TSchema, I extends PropertyKey[] = TIndexPropertyKeys<K>>(T: T, K: K, options?: SchemaOptions): TPick<T, I>;
+    /** `[Json]` Constructs a type whose keys are picked from the given type */
     Pick<T extends TSchema, K extends PropertyKey[]>(T: T, K: readonly [...K], options?: SchemaOptions): TPick<T, K>;
+    /** `[Json]` Creates a Record type */
     Record<K extends TSchema, T extends TSchema>(key: K, schema: T, options?: ObjectOptions): RecordResolve<K, T>;
+    /** `[Json]` Creates a Recursive type */
     Recursive<T extends TSchema>(callback: (thisType: TThis) => T, options?: SchemaOptions): TRecursive<T>;
+    /** `[Json]` Creates a Ref type. The referenced type must contain a $id */
     Ref<T extends TSchema>(schema: T, options?: SchemaOptions): TRef<T>;
+    /** `[Json]` Creates a Ref type. */
     Ref<T extends TSchema>($ref: string, options?: SchemaOptions): TRef<T>;
+    /** `[Json]` Constructs a type where all properties are required */
     Required<T extends TMappedResult>(T: T, options?: ObjectOptions): TRequiredFromMappedResult<T>;
+    /** `[Json]` Constructs a type where all properties are required */
     Required<T extends TSchema>(schema: T, options?: ObjectOptions): TRequired<T>;
+    /** `[Json]` Extracts interior Rest elements from Tuple, Intersect and Union types */
     Rest<T extends TSchema>(schema: T): TRest<T>;
+    /** `[Json]` Creates a String type */
     String(options?: StringOptions): TString;
+    /** `[Json]` Creates a TemplateLiteral type from template dsl string */
     TemplateLiteral<T extends string>(syntax: T, options?: SchemaOptions): TemplateLiteralSyntax<T>;
+    /** `[Json]` Creates a TemplateLiteral type */
     TemplateLiteral<T extends TTemplateLiteralKind[]>(kinds: [...T], options?: SchemaOptions): TTemplateLiteral<T>;
+    /** `[Json]` Creates a Transform type */
     Transform<I extends TSchema>(schema: I): TransformDecodeBuilder<I>;
+    /** `[Json]` Creates a Tuple type */
     Tuple<T extends TSchema[]>(items: [...T], options?: SchemaOptions): TTuple<T>;
+    /** `[Json]` Intrinsic function to Uncapitalize LiteralString types */
     Uncapitalize<T extends TSchema>(schema: T, options?: SchemaOptions): TUncapitalize<T>;
-    Union<T extends TSchema[]>(schemas: [...T], options?: SchemaOptions): UnionResolve<T>;
+    /** `[Json]` Creates a Union type */
+    Union<T extends TSchema[]>(schemas: [...T], options?: SchemaOptions): Union<T>;
+    /** `[Json]` Creates an Unknown type */
     Unknown(options?: SchemaOptions): TUnknown;
+    /** `[Json]` Creates a Unsafe type that will infers as the generic argument T */
     Unsafe<T>(options?: UnsafeOptions): TUnsafe<T>;
+    /** `[Json]` Intrinsic function to Uppercase LiteralString types */
     Uppercase<T extends TSchema>(schema: T, options?: SchemaOptions): TUppercase<T>;
 }

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

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonTypeBuilder = void 0;
 const index_1 = require("../any/index");
@@ -42,136 +69,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,37 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
 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,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
 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,35 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
 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' };
 }