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

package/build/require/type/registry/format.d.ts

@@ -1,7 +1,13 @@
 export type FormatRegistryValidationFunction = (value: string) => boolean;
+/** Returns the entries in this registry */
 export declare function Entries(): Map<string, FormatRegistryValidationFunction>;
+/** Clears all user defined string formats */
 export declare function Clear(): void;
+/** Deletes a registered format */
 export declare function Delete(format: string): boolean;
+/** Returns true if the user defined string format exists */
 export declare function Has(format: string): boolean;
+/** Sets a validation function for a user defined string format */
 export declare function Set(format: string, func: FormatRegistryValidationFunction): void;
+/** Gets a validation function for a user defined string format */
 export declare function Get(format: string): FormatRegistryValidationFunction | undefined;

package/build/require/type/registry/format.js

@@ -1,27 +1,35 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Get = exports.Set = exports.Has = exports.Delete = exports.Clear = exports.Entries = void 0;
+/** A registry for user defined string formats */
 const map = new Map();
+/** Returns the entries in this registry */
 function Entries() {
     return new Map(map);
 }
 exports.Entries = Entries;
+/** Clears all user defined string formats */
 function Clear() {
     return map.clear();
 }
 exports.Clear = Clear;
+/** Deletes a registered format */
 function Delete(format) {
     return map.delete(format);
 }
 exports.Delete = Delete;
+/** Returns true if the user defined string format exists */
 function Has(format) {
     return map.has(format);
 }
 exports.Has = Has;
+/** Sets a validation function for a user defined string format */
 function Set(format, func) {
     map.set(format, func);
 }
 exports.Set = Set;
+/** Gets a validation function for a user defined string format */
 function Get(format) {
     return map.get(format);
 }

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

@@ -1,4 +1,5 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypeRegistry = exports.FormatRegistry = void 0;
 exports.FormatRegistry = require("./format");

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

@@ -1,7 +1,13 @@
 export type TypeRegistryValidationFunction<TSchema> = (schema: TSchema, value: unknown) => boolean;
+/** Returns the entries in this registry */
 export declare function Entries(): Map<string, TypeRegistryValidationFunction<any>>;
+/** Clears all user defined types */
 export declare function Clear(): void;
+/** Deletes a registered type */
 export declare function Delete(kind: string): boolean;
+/** Returns true if this registry contains this kind */
 export declare function Has(kind: string): boolean;
+/** Sets a validation function for a user defined type */
 export declare function Set<TSchema = unknown>(kind: string, func: TypeRegistryValidationFunction<TSchema>): void;
+/** Gets a custom validation function for a user defined type */
 export declare function Get(kind: string): TypeRegistryValidationFunction<any> | undefined;

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

@@ -1,27 +1,35 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Get = exports.Set = exports.Has = exports.Delete = exports.Clear = exports.Entries = void 0;
+/** A registry for user defined types */
 const map = new Map();
+/** Returns the entries in this registry */
 function Entries() {
     return new Map(map);
 }
 exports.Entries = Entries;
+/** Clears all user defined types */
 function Clear() {
     return map.clear();
 }
 exports.Clear = Clear;
+/** Deletes a registered type */
 function Delete(kind) {
     return map.delete(kind);
 }
 exports.Delete = Delete;
+/** Returns true if this registry contains this kind */
 function Has(kind) {
     return map.has(kind);
 }
 exports.Has = Has;
+/** Sets a validation function for a user defined type */
 function Set(kind, func) {
     map.set(kind, func);
 }
 exports.Set = Set;
+/** Gets a custom validation function for a user defined type */
 function Get(kind) {
     return map.get(kind);
 }

package/build/require/type/required/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/required/required-from-mapped-result.js

@@ -1,16 +1,20 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequiredFromMappedResult = void 0;
 const index_1 = require("../mapped/index");
 const required_1 = require("./required");
+// prettier-ignore
 function FromProperties(K, options) {
     return globalThis.Object.getOwnPropertyNames(K).reduce((Acc, K2) => {
         return { ...Acc, [K2]: (0, required_1.Required)(K[K2], options) };
     }, {});
 }
+// prettier-ignore
 function FromMappedResult(K, options) {
     return FromProperties(K.properties, options);
 }
+// prettier-ignore
 function RequiredFromMappedResult(T, options) {
     const P = FromMappedResult(T, options);
     return (0, index_1.MappedResult)(P);

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

@@ -20,6 +20,8 @@ declare function FromProperties<T extends TProperties>(T: T): TProperties;
 type RequiredResolve<T extends TSchema> = (T extends TRecursive<infer S> ? TRecursive<RequiredResolve<S>> : T extends TIntersect<infer S> ? TIntersect<FromIntersect<S>> : T extends TUnion<infer S> ? TUnion<FromUnion<S>> : T extends TObject<infer S> ? TObject<FromProperties<S>> : TObject<{}>);
 declare function RequiredResolve<T extends TSchema>(T: T): RequiredResolve<T>;
 export type TRequired<T extends TSchema> = RequiredResolve<T>;
+/** `[Json]` Constructs a type where all properties are required */
 export declare function Required<T extends TMappedResult>(T: T, options?: SchemaOptions): TRequiredFromMappedResult<T>;
+/** `[Json]` Constructs a type where all properties are required */
 export declare function Required<T extends TSchema>(T: T, options?: SchemaOptions): TRequired<T>;
 export {};

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

@@ -1,4 +1,5 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Required = void 0;
 const index_1 = require("../intersect/index");
@@ -8,30 +9,39 @@ const index_4 = require("../symbols/index");
 const type_1 = require("../clone/type");
 const index_5 = require("../discard/index");
 const required_from_mapped_result_1 = require("./required-from-mapped-result");
+// ------------------------------------------------------------------
+// TypeGuard
+// ------------------------------------------------------------------
+// prettier-ignore
 const type_2 = require("../guard/type");
+// prettier-ignore
 function FromIntersect(T) {
     const [L, ...R] = T;
     return (T.length > 0
         ? [RequiredResolve(L), ...FromIntersect(R)]
         : []);
 }
+// prettier-ignore
 function FromUnion(T) {
     const [L, ...R] = T;
     return (T.length > 0
         ? [RequiredResolve(L), ...FromUnion(R)]
         : []);
 }
+// prettier-ignore
 function FromProperties(T) {
     return globalThis.Object.getOwnPropertyNames(T).reduce((Acc, K) => {
         return { ...Acc, [K]: (0, index_5.Discard)(T[K], [index_4.OptionalKind]) };
     }, {});
 }
+// prettier-ignore
 function RequiredResolve(T) {
     return ((0, type_2.TIntersect)(T) ? (0, index_1.Intersect)(FromIntersect(T.allOf)) :
         (0, type_2.TUnion)(T) ? (0, index_2.Union)(FromUnion(T.anyOf)) :
             (0, type_2.TObject)(T) ? (0, index_3.Object)(FromProperties(T.properties)) :
                 (0, index_3.Object)({}));
 }
+/** `[Json]` Constructs a type where all properties are required */
 function Required(T, options = {}) {
     if ((0, type_2.TMappedResult)(T)) {
         return (0, required_from_mapped_result_1.RequiredFromMappedResult)(T, options);

package/build/require/type/rest/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/rest/rest.d.ts

@@ -6,4 +6,5 @@ export type RestResolve<T extends TSchema> = T extends TIntersect<infer S> ? [..
 ];
 export declare function RestResolve<T extends TSchema>(T: T): RestResolve<T>;
 export type TRest<T extends TSchema> = RestResolve<T>;
+/** `[Json]` Extracts interior Rest elements from Tuple, Intersect and Union types */
 export declare function Rest<T extends TSchema>(T: T): TRest<T>;

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

@@ -1,12 +1,18 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Rest = exports.RestResolve = void 0;
 const type_1 = require("../clone/type");
+// ------------------------------------------------------------------
+// TypeGuard
+// ------------------------------------------------------------------
+// prettier-ignore
 const type_2 = require("../guard/type");
 function RestResolve(T) {
     return ((0, type_2.TIntersect)(T) ? [...T.allOf] : (0, type_2.TUnion)(T) ? [...T.anyOf] : (0, type_2.TTuple)(T) ? [...(T.items ?? [])] : []);
 }
 exports.RestResolve = RestResolve;
+/** `[Json]` Extracts interior Rest elements from Tuple, Intersect and Union types */
 function Rest(T) {
     return (0, type_1.CloneRest)(RestResolve(T));
 }

package/build/require/type/return-type/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/return-type/return-type.d.ts

@@ -1,4 +1,5 @@
 import type { SchemaOptions } from '../schema/index';
 import type { TFunction } from '../function/index';
 export type TReturnType<T extends TFunction> = T['returns'];
+/** `[JavaScript]` Extracts the ReturnType from the given Function type */
 export declare function ReturnType<T extends TFunction<any[], any>>(schema: T, options?: SchemaOptions): TReturnType<T>;

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

@@ -1,7 +1,9 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnType = void 0;
 const type_1 = require("../clone/type");
+/** `[JavaScript]` Extracts the ReturnType from the given Function type */
 function ReturnType(schema, options = {}) {
     return (0, type_1.CloneType)(schema.returns, options);
 }

package/build/require/type/schema/anyschema.js

@@ -1,2 +1,3 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });

package/build/require/type/schema/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/schema/schema.d.ts

@@ -1,12 +1,19 @@
 import { Kind, Hint, ReadonlyKind, OptionalKind } from '../symbols/index';
 export interface SchemaOptions {
     $schema?: string;
+    /** Id for this schema */
     $id?: string;
+    /** Title of this schema */
     title?: string;
+    /** Description of this schema */
     description?: string;
+    /** Default value for this schema */
     default?: any;
+    /** Example values matching this schema */
     examples?: any;
+    /** Optional annotation for readOnly */
     readOnly?: boolean;
+    /** Optional annotation for writeOnly */
     writeOnly?: boolean;
     [prop: string]: any;
 }

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

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

package/build/require/type/static/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/static/static.d.ts

@@ -24,8 +24,11 @@ export type DecodeProperties<T extends TProperties> = {
 };
 export type DecodeRest<T extends TSchema[]> = T extends [infer L extends TSchema, ...infer R extends TSchema[]] ? [DecodeType<L>, ...DecodeRest<R>] : [];
 export type DecodeType<T extends TSchema> = (T extends TOptional<infer S extends TSchema> ? TOptional<DecodeType<S>> : T extends TReadonly<infer S extends TSchema> ? TReadonly<DecodeType<S>> : T extends TTransform<infer _, infer R> ? TUnsafe<R> : T extends TArray<infer S extends TSchema> ? TArray<DecodeType<S>> : T extends TAsyncIterator<infer S extends TSchema> ? TAsyncIterator<DecodeType<S>> : T extends TConstructor<infer P extends TSchema[], infer R extends TSchema> ? TConstructor<DecodeRest<P>, DecodeType<R>> : T extends TEnum<infer S> ? TEnum<S> : T extends TFunction<infer P extends TSchema[], infer R extends TSchema> ? TFunction<DecodeRest<P>, DecodeType<R>> : T extends TIntersect<infer S extends TSchema[]> ? TIntersect<DecodeRest<S>> : T extends TIterator<infer S extends TSchema> ? TIterator<DecodeType<S>> : T extends TNot<infer S extends TSchema> ? TNot<DecodeType<S>> : T extends TObject<infer S> ? TObject<Evaluate<DecodeProperties<S>>> : T extends TPromise<infer S extends TSchema> ? TPromise<DecodeType<S>> : T extends TRecord<infer K, infer S> ? TRecord<K, DecodeType<S>> : T extends TRecursive<infer S extends TSchema> ? TRecursive<DecodeType<S>> : T extends TRef<infer S extends TSchema> ? TRef<DecodeType<S>> : T extends TTuple<infer S extends TSchema[]> ? TTuple<DecodeRest<S>> : T extends TUnion<infer S extends TSchema[]> ? TUnion<DecodeRest<S>> : T);
+/** Creates an decoded static type from a TypeBox type */
 export type StaticDecode<T extends TSchema, P extends unknown[] = []> = Static<DecodeType<T>, P>;
+/** Creates an encoded static type from a TypeBox type */
 export type StaticEncode<T extends TSchema, P extends unknown[] = []> = Static<T, P>;
+/** Creates a static type from a TypeBox type */
 export type Static<T extends TSchema, P extends unknown[] = []> = (T & {
     params: P;
 })['static'];

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

@@ -1,2 +1,3 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });

package/build/require/type/strict/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/strict/strict.d.ts

@@ -1,2 +1,3 @@
 import type { TSchema } from '../schema/index';
+/** `[Json]` Omits compositing symbols from this schema */
 export declare function Strict<T extends TSchema>(schema: T): T;

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

@@ -1,6 +1,8 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Strict = void 0;
+/** `[Json]` Omits compositing symbols from this schema */
 function Strict(schema) {
     return JSON.parse(JSON.stringify(schema));
 }

package/build/require/type/string/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/string/string.d.ts

@@ -3,11 +3,17 @@ import { Kind } from '../symbols/index';
 export type StringFormatOption = 'date-time' | 'time' | 'date' | 'email' | 'idn-email' | 'hostname' | 'idn-hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uri-reference' | 'iri' | 'uuid' | 'iri-reference' | 'uri-template' | 'json-pointer' | 'relative-json-pointer' | 'regex' | ({} & string);
 export type StringContentEncodingOption = '7bit' | '8bit' | 'binary' | 'quoted-printable' | 'base64' | ({} & string);
 export interface StringOptions extends SchemaOptions {
+    /** The maximum string length */
     maxLength?: number;
+    /** The minimum string length */
     minLength?: number;
+    /** A regular expression pattern this string should match */
     pattern?: string;
+    /** A format this string should match */
     format?: StringFormatOption;
+    /** The content encoding for this string */
     contentEncoding?: StringContentEncodingOption;
+    /** The content media type for this string */
     contentMediaType?: string;
 }
 export interface TString extends TSchema, StringOptions {
@@ -15,4 +21,5 @@ export interface TString extends TSchema, StringOptions {
     static: string;
     type: 'string';
 }
+/** `[Json]` Creates a String type */
 export declare function String(options?: StringOptions): TString;

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

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

package/build/require/type/symbol/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/symbol/symbol.d.ts

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

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

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

package/build/require/type/symbols/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/symbols/symbols.d.ts

@@ -1,5 +1,10 @@
+/** Symbol key applied to transform types */
 export declare const TransformKind: unique symbol;
+/** Symbol key applied to readonly types */
 export declare const ReadonlyKind: unique symbol;
+/** Symbol key applied to optional types */
 export declare const OptionalKind: unique symbol;
+/** Symbol key applied to types */
 export declare const Hint: unique symbol;
+/** Symbol key applied to types */
 export declare const Kind: unique symbol;

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

@@ -1,8 +1,14 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Kind = exports.Hint = exports.OptionalKind = exports.ReadonlyKind = exports.TransformKind = void 0;
+/** Symbol key applied to transform types */
 exports.TransformKind = Symbol.for('TypeBox.Transform');
+/** Symbol key applied to readonly types */
 exports.ReadonlyKind = Symbol.for('TypeBox.Readonly');
+/** Symbol key applied to optional types */
 exports.OptionalKind = Symbol.for('TypeBox.Optional');
+/** Symbol key applied to types */
 exports.Hint = Symbol.for('TypeBox.Hint');
+/** Symbol key applied to types */
 exports.Kind = Symbol.for('TypeBox.Kind');

package/build/require/type/template-literal/finite.js

@@ -1,9 +1,17 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsTemplateLiteralFinite = exports.TemplateLiteralFiniteError = void 0;
+// ------------------------------------------------------------------
+// TemplateLiteralFiniteError
+// ------------------------------------------------------------------
 class TemplateLiteralFiniteError extends Error {
 }
 exports.TemplateLiteralFiniteError = TemplateLiteralFiniteError;
+// ------------------------------------------------------------------
+// IsTemplateLiteralFiniteCheck
+// ------------------------------------------------------------------
+// prettier-ignore
 function IsNumberExpression(expression) {
     return (expression.type === 'or' &&
         expression.expr.length === 2 &&
@@ -12,6 +20,7 @@ function IsNumberExpression(expression) {
         expression.expr[1].type === 'const' &&
         expression.expr[1].const === '[1-9][0-9]*');
 }
+// prettier-ignore
 function IsBooleanExpression(expression) {
     return (expression.type === 'or' &&
         expression.expr.length === 2 &&
@@ -20,9 +29,11 @@ function IsBooleanExpression(expression) {
         expression.expr[1].type === 'const' &&
         expression.expr[1].const === 'false');
 }
+// prettier-ignore
 function IsStringExpression(expression) {
     return expression.type === 'const' && expression.const === '.*';
 }
+// prettier-ignore
 function IsTemplateLiteralFinite(expression) {
     return (IsBooleanExpression(expression) ? true :
         IsNumberExpression(expression) || IsStringExpression(expression) ? false :

package/build/require/type/template-literal/generate.js

@@ -1,6 +1,11 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateLiteralGenerate = exports.TemplateLiteralGenerateError = void 0;
+// ------------------------------------------------------------------
+// GenerateFromExpression
+// ------------------------------------------------------------------
+// prettier-ignore
 function* GenerateReduce(buffer) {
     if (buffer.length === 1)
         return yield* buffer[0];
@@ -10,16 +15,22 @@ function* GenerateReduce(buffer) {
         }
     }
 }
+// prettier-ignore
 function* GenerateAnd(expression) {
     return yield* GenerateReduce(expression.expr.map((expr) => [...TemplateLiteralGenerate(expr)]));
 }
+// prettier-ignore
 function* GenerateOr(expression) {
     for (const expr of expression.expr)
         yield* TemplateLiteralGenerate(expr);
 }
+// prettier-ignore
 function* GenerateConst(expression) {
     return yield expression.const;
 }
+// ------------------------------------------------------------------
+// TemplateLiteralGenerateError
+// ------------------------------------------------------------------
 class TemplateLiteralGenerateError extends Error {
 }
 exports.TemplateLiteralGenerateError = TemplateLiteralGenerateError;

package/build/require/type/template-literal/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/template-literal/parser.d.ts

@@ -13,5 +13,7 @@ export type ExpressionOr = {
     type: 'or';
     expr: Expression[];
 };
+/** Parses a pattern and returns an expression tree */
 export declare function TemplateLiteralParse(pattern: string): Expression;
+/** Parses a pattern and strips forward and trailing ^ and $ */
 export declare function TemplateLiteralParseExact(pattern: string): Expression;

package/build/require/type/template-literal/parser.js

@@ -1,21 +1,30 @@
 "use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateLiteralParseExact = exports.TemplateLiteralParse = exports.TemplateLiteralParserError = void 0;
+// ------------------------------------------------------------------
+// TemplateLiteralParserError
+// ------------------------------------------------------------------
 class TemplateLiteralParserError extends Error {
 }
 exports.TemplateLiteralParserError = TemplateLiteralParserError;
+// prettier-ignore
 function IsNonEscaped(pattern, index, char) {
     return pattern[index] === char && pattern.charCodeAt(index - 1) !== 92;
 }
+// prettier-ignore
 function IsOpenParen(pattern, index) {
     return IsNonEscaped(pattern, index, '(');
 }
+// prettier-ignore
 function IsCloseParen(pattern, index) {
     return IsNonEscaped(pattern, index, ')');
 }
+// prettier-ignore
 function IsSeparator(pattern, index) {
     return IsNonEscaped(pattern, index, '|');
 }
+// prettier-ignore
 function IsGroup(pattern) {
     if (!(IsOpenParen(pattern, 0) && IsCloseParen(pattern, pattern.length - 1)))
         return false;
@@ -30,9 +39,11 @@ function IsGroup(pattern) {
     }
     return true;
 }
+// prettier-ignore
 function InGroup(pattern) {
     return pattern.slice(1, pattern.length - 1);
 }
+// prettier-ignore
 function IsPrecedenceOr(pattern) {
     let count = 0;
     for (let index = 0; index < pattern.length; index++) {
@@ -45,6 +56,7 @@ function IsPrecedenceOr(pattern) {
     }
     return false;
 }
+// prettier-ignore
 function IsPrecedenceAnd(pattern) {
     for (let index = 0; index < pattern.length; index++) {
         if (IsOpenParen(pattern, index))
@@ -52,6 +64,7 @@ function IsPrecedenceAnd(pattern) {
     }
     return false;
 }
+// prettier-ignore
 function Or(pattern) {
     let [count, start] = [0, 0];
     const expressions = [];
@@ -76,6 +89,7 @@ function Or(pattern) {
         return expressions[0];
     return { type: 'or', expr: expressions };
 }
+// prettier-ignore
 function And(pattern) {
     function Group(value, index) {
         if (!IsOpenParen(value, index))
@@ -118,6 +132,8 @@ function And(pattern) {
         (expressions.length === 1) ? expressions[0] :
             { type: 'and', expr: expressions });
 }
+/** Parses a pattern and returns an expression tree */
+// prettier-ignore
 function TemplateLiteralParse(pattern) {
     return (IsGroup(pattern) ? TemplateLiteralParse(InGroup(pattern)) :
         IsPrecedenceOr(pattern) ? Or(pattern) :
@@ -125,6 +141,8 @@ function TemplateLiteralParse(pattern) {
                 { type: 'const', const: pattern });
 }
 exports.TemplateLiteralParse = TemplateLiteralParse;
+/** Parses a pattern and strips forward and trailing ^ and $ */
+// prettier-ignore
 function TemplateLiteralParseExact(pattern) {
     return TemplateLiteralParse(pattern.slice(1, pattern.length - 1));
 }