effect 4.0.0-beta.67 → 4.0.0-beta.69

package/dist/SchemaAST.d.ts

@@ -92,8 +92,8 @@ import * as Transformation from "./SchemaTransformation.ts";
  * @see {@link Base}
  * @see {@link isAST}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export type AST = Declaration | Null | Undefined | Void | Never | Unknown | Any | String | Number | Boolean | BigInt | Symbol | Literal | UniqueSymbol | ObjectKeyword | Enum | TemplateLiteral | Arrays | Objects | Union | Suspend;
 /**
@@ -104,155 +104,155 @@ export type AST = Declaration | Null | Undefined | Void | Never | Unknown | Any
  *
  * @see {@link AST}
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare function isAST(u: unknown): u is AST;
 /**
  * Narrows an {@link AST} to {@link Declaration}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export declare const isDeclaration: (ast: AST) => ast is Declaration;
 /**
  * Narrows an {@link AST} to {@link Null}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isNull: (ast: AST) => ast is Null;
 /**
  * Narrows an {@link AST} to {@link Undefined}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isUndefined: (ast: AST) => ast is Undefined;
 /**
  * Narrows an {@link AST} to {@link Void}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isVoid: (ast: AST) => ast is Void;
 /**
  * Narrows an {@link AST} to {@link Never}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isNever: (ast: AST) => ast is Never;
 /**
  * Narrows an {@link AST} to {@link Unknown}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isUnknown: (ast: AST) => ast is Unknown;
 /**
  * Narrows an {@link AST} to {@link Any}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isAny: (ast: AST) => ast is Any;
 /**
  * Narrows an {@link AST} to {@link String}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isString: (ast: AST) => ast is String;
 /**
  * Narrows an {@link AST} to {@link Number}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isNumber: (ast: AST) => ast is Number;
 /**
  * Narrows an {@link AST} to {@link Boolean}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isBoolean: (ast: AST) => ast is Boolean;
 /**
  * Narrows an {@link AST} to {@link BigInt}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isBigInt: (ast: AST) => ast is BigInt;
 /**
  * Narrows an {@link AST} to {@link Symbol}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isSymbol: (ast: AST) => ast is Symbol;
 /**
  * Narrows an {@link AST} to {@link Literal}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export declare const isLiteral: (ast: AST) => ast is Literal;
 /**
  * Narrows an {@link AST} to {@link UniqueSymbol}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export declare const isUniqueSymbol: (ast: AST) => ast is UniqueSymbol;
 /**
  * Narrows an {@link AST} to {@link ObjectKeyword}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export declare const isObjectKeyword: (ast: AST) => ast is ObjectKeyword;
 /**
  * Narrows an {@link AST} to {@link Enum}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isEnum: (ast: AST) => ast is Enum;
 /**
  * Narrows an {@link AST} to {@link TemplateLiteral}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export declare const isTemplateLiteral: (ast: AST) => ast is TemplateLiteral;
 /**
  * Narrows an {@link AST} to {@link Arrays}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isArrays: (ast: AST) => ast is Arrays;
 /**
  * Narrows an {@link AST} to {@link Objects}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isObjects: (ast: AST) => ast is Objects;
 /**
  * Narrows an {@link AST} to {@link Union}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export declare const isUnion: (ast: AST) => ast is Union<AST>;
 /**
  * Narrows an {@link AST} to {@link Suspend}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export declare const isSuspend: (ast: AST) => ast is Suspend;
 /**
@@ -269,7 +269,7 @@ export declare const isSuspend: (ast: AST) => ast is Suspend;
  * @see {@link Encoding}
  * @see {@link decodeTo}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Link {
@@ -287,7 +287,7 @@ export declare class Link {
  * @see {@link Link}
  * @see {@link toEncoded}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type Encoding = readonly [Link, ...Array<Link>];
@@ -309,8 +309,8 @@ export type Encoding = readonly [Link, ...Array<Link>];
  * - `concurrency` — maximum number of async parse effects to run concurrently;
  *   defaults to `1`, or use `"unbounded"`.
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export interface ParseOptions {
     /**
@@ -387,7 +387,7 @@ export interface ParseOptions {
  * @see {@link optionalKey}
  * @see {@link isOptional}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Context {
@@ -411,7 +411,7 @@ export declare class Context {
  * @see {@link Filter}
  * @see {@link FilterGroup}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type Checks = readonly [Check<any>, ...Array<Check<any>>];
@@ -432,7 +432,7 @@ declare const TypeId = "~effect/Schema";
  *
  * @see {@link AST}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare abstract class Base {
@@ -457,8 +457,8 @@ export declare abstract class Base {
  *
  * @see {@link isDeclaration}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class Declaration extends Base {
     readonly _tag = "Declaration";
@@ -474,7 +474,7 @@ export declare class Declaration extends Base {
  * @see {@link null}
  * @see {@link isNull}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Null extends Base {
@@ -496,7 +496,7 @@ null_ as null };
  * @see {@link undefined}
  * @see {@link isUndefined}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Undefined extends Base {
@@ -519,7 +519,7 @@ undefined_ as undefined };
  * @see {@link void}
  * @see {@link isVoid}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Void extends Base {
@@ -542,7 +542,7 @@ void_ as void };
  * @see {@link never}
  * @see {@link isNever}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Never extends Base {
@@ -551,6 +551,7 @@ export declare class Never extends Base {
 /**
  * Singleton {@link Never} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const never: Never;
@@ -560,7 +561,7 @@ export declare const never: Never;
  * @see {@link any}
  * @see {@link isAny}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Any extends Base {
@@ -569,6 +570,7 @@ export declare class Any extends Base {
 /**
  * Singleton {@link Any} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const any: Any;
@@ -581,7 +583,7 @@ export declare const any: Any;
  * @see {@link unknown}
  * @see {@link isUnknown}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Unknown extends Base {
@@ -590,6 +592,7 @@ export declare class Unknown extends Base {
 /**
  * Singleton {@link Unknown} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const unknown: Unknown;
@@ -600,8 +603,8 @@ export declare const unknown: Unknown;
  * @see {@link objectKeyword}
  * @see {@link isObjectKeyword}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class ObjectKeyword extends Base {
     readonly _tag = "ObjectKeyword";
@@ -609,7 +612,8 @@ export declare class ObjectKeyword extends Base {
 /**
  * Singleton {@link ObjectKeyword} AST instance.
  *
- * @since 4.0.0
+ * @category constructors
+ * @since 3.10.0
  */
 export declare const objectKeyword: ObjectKeyword;
 /**
@@ -620,7 +624,7 @@ export declare const objectKeyword: ObjectKeyword;
  *
  * @see {@link isEnum}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Enum extends Base {
@@ -638,8 +642,8 @@ export declare class Enum extends Base {
  *
  * @see {@link isTemplateLiteral}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class TemplateLiteral extends Base {
     readonly _tag = "TemplateLiteral";
@@ -654,8 +658,8 @@ export declare class TemplateLiteral extends Base {
  *
  * @see {@link isUniqueSymbol}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class UniqueSymbol extends Base {
     readonly _tag = "UniqueSymbol";
@@ -667,8 +671,8 @@ export declare class UniqueSymbol extends Base {
  *
  * @see {@link Literal}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export type LiteralValue = string | number | boolean | bigint;
 /**
@@ -691,8 +695,8 @@ export type LiteralValue = string | number | boolean | bigint;
  * @see {@link LiteralValue}
  * @see {@link isLiteral}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class Literal extends Base {
     readonly _tag = "Literal";
@@ -705,7 +709,7 @@ export declare class Literal extends Base {
  * @see {@link string}
  * @see {@link isString}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class String extends Base {
@@ -714,6 +718,7 @@ export declare class String extends Base {
 /**
  * Singleton {@link String} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const string: String;
@@ -731,7 +736,7 @@ export declare const string: String;
  * @see {@link number}
  * @see {@link isNumber}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Number extends Base {
@@ -740,6 +745,7 @@ export declare class Number extends Base {
 /**
  * Singleton {@link Number} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const number: Number;
@@ -749,7 +755,7 @@ export declare const number: Number;
  * @see {@link boolean}
  * @see {@link isBoolean}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Boolean extends Base {
@@ -758,6 +764,7 @@ export declare class Boolean extends Base {
 /**
  * Singleton {@link Boolean} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const boolean: Boolean;
@@ -770,7 +777,7 @@ export declare const boolean: Boolean;
  * @see {@link symbol}
  * @see {@link isSymbol}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Symbol extends Base {
@@ -779,6 +786,7 @@ export declare class Symbol extends Base {
 /**
  * Singleton {@link Symbol} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const symbol: Symbol;
@@ -791,7 +799,7 @@ export declare const symbol: Symbol;
  * @see {@link bigInt}
  * @see {@link isBigInt}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class BigInt extends Base {
@@ -800,6 +808,7 @@ export declare class BigInt extends Base {
 /**
  * Singleton {@link BigInt} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const bigInt: BigInt;
@@ -835,7 +844,7 @@ export declare const bigInt: BigInt;
  * @see {@link isArrays}
  * @see {@link Objects}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Arrays extends Base {
@@ -854,8 +863,8 @@ export declare class Arrays extends Base {
  *
  * @see {@link Objects}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class PropertySignature {
     readonly name: PropertyKey;
@@ -872,7 +881,7 @@ export declare class PropertySignature {
  *
  * @see {@link IndexSignature}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class KeyValueCombiner {
@@ -894,8 +903,8 @@ export declare class KeyValueCombiner {
  * @see {@link Objects}
  * @see {@link PropertySignature}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class IndexSignature {
     readonly parameter: AST;
@@ -937,7 +946,7 @@ export declare class IndexSignature {
  * @see {@link IndexSignature}
  * @see {@link Arrays}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Objects extends Base {
@@ -974,8 +983,8 @@ export declare class Objects extends Base {
  *
  * @see {@link isUnion}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class Union<A extends AST = AST> extends Base {
     readonly _tag = "Union";
@@ -1010,8 +1019,8 @@ export declare class Union<A extends AST = AST> extends Base {
  *
  * @see {@link isSuspend}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export declare class Suspend extends Base {
     readonly _tag = "Suspend";
@@ -1035,7 +1044,7 @@ export declare class Suspend extends Base {
  * @see {@link Check}
  * @see {@link isPattern}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class Filter<in E> extends Pipeable.Class {
@@ -1065,7 +1074,7 @@ export declare class Filter<in E> extends Pipeable.Class {
  * @see {@link Filter}
  * @see {@link Check}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export declare class FilterGroup<in E> extends Pipeable.Class {
@@ -1085,7 +1094,7 @@ export declare class FilterGroup<in E> extends Pipeable.Class {
  * @see {@link Filter}
  * @see {@link FilterGroup}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type Check<T> = Filter<T> | FilterGroup<T>;
@@ -1110,6 +1119,7 @@ export type Check<T> = Filter<T> | FilterGroup<T>;
  *
  * @see {@link Filter}
  *
+ * @category constructors
  * @since 4.0.0
  */
 export declare function isPattern(regExp: globalThis.RegExp, annotations?: Schema.Annotations.Filter): Filter<string>;
@@ -1124,6 +1134,7 @@ export declare function mapOrSame<A>(as: ReadonlyArray<A>, f: (a: A) => A): Read
  * @see {@link isOptional}
  * @see {@link Context}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export declare function optionalKey<A extends AST>(ast: A): A;
@@ -1142,6 +1153,7 @@ export declare function optionalKey<A extends AST>(ast: A): A;
  * @see {@link Encoding}
  * @see {@link flip}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export declare function decodeTo<A extends AST>(from: AST, to: A, transformation: Transformation.Transformation<any, any, any, any>): A;
@@ -1154,6 +1166,7 @@ export declare function decodeTo<A extends AST>(from: AST, to: A, transformation
  * @see {@link optionalKey}
  * @see {@link Context}
  *
+ * @category predicates
  * @since 4.0.0
  */
 export declare function isOptional(ast: AST): boolean;
@@ -1179,6 +1192,7 @@ export declare function isOptional(ast: AST): boolean;
  * @see {@link toEncoded}
  * @see {@link flip}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export declare const toType: <A extends AST>(ast: A) => A;
@@ -1205,6 +1219,7 @@ export declare const toType: <A extends AST>(ast: A) => A;
  * @see {@link toType}
  * @see {@link flip}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export declare const toEncoded: (ast: AST) => AST;
@@ -1222,6 +1237,7 @@ export declare const toEncoded: (ast: AST) => AST;
  * @see {@link toType}
  * @see {@link toEncoded}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export declare const flip: (ast: AST) => AST;
@@ -1247,6 +1263,7 @@ export declare const flip: (ast: AST) => AST;
  * @see {@link resolveTitle}
  * @see {@link resolveDescription}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export declare const resolve: (ast: AST) => Schema.Annotations.Annotations | undefined;
@@ -1258,6 +1275,7 @@ export declare const resolve: (ast: AST) => Schema.Annotations.Annotations | und
  *
  * @see {@link resolve}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export declare const resolveAt: <A>(key: string) => (ast: AST) => A | undefined;
@@ -1270,6 +1288,7 @@ export declare const resolveAt: <A>(key: string) => (ast: AST) => A | undefined;
  * @see {@link resolve}
  * @see {@link resolveTitle}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export declare const resolveIdentifier: (ast: AST) => string | undefined;
@@ -1280,6 +1299,7 @@ export declare const resolveIdentifier: (ast: AST) => string | undefined;
  * @see {@link resolveIdentifier}
  * @see {@link resolveDescription}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export declare const resolveTitle: (ast: AST) => string | undefined;
@@ -1290,6 +1310,7 @@ export declare const resolveTitle: (ast: AST) => string | undefined;
  * @see {@link resolveTitle}
  * @see {@link resolveIdentifier}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export declare const resolveDescription: (ast: AST) => string | undefined;