effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/SchemaAST.js

@@ -100,7 +100,7 @@ function makeGuard(tag) {
  *
  * @see {@link AST}
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export function isAST(u) {
@@ -109,148 +109,148 @@ export function isAST(u) {
 /**
  * Narrows an {@link AST} to {@link Declaration}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export const isDeclaration = /*#__PURE__*/makeGuard("Declaration");
 /**
  * Narrows an {@link AST} to {@link Null}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isNull = /*#__PURE__*/makeGuard("Null");
 /**
  * Narrows an {@link AST} to {@link Undefined}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isUndefined = /*#__PURE__*/makeGuard("Undefined");
 /**
  * Narrows an {@link AST} to {@link Void}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isVoid = /*#__PURE__*/makeGuard("Void");
 /**
  * Narrows an {@link AST} to {@link Never}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isNever = /*#__PURE__*/makeGuard("Never");
 /**
  * Narrows an {@link AST} to {@link Unknown}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isUnknown = /*#__PURE__*/makeGuard("Unknown");
 /**
  * Narrows an {@link AST} to {@link Any}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isAny = /*#__PURE__*/makeGuard("Any");
 /**
  * Narrows an {@link AST} to {@link String}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isString = /*#__PURE__*/makeGuard("String");
 /**
  * Narrows an {@link AST} to {@link Number}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isNumber = /*#__PURE__*/makeGuard("Number");
 /**
  * Narrows an {@link AST} to {@link Boolean}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isBoolean = /*#__PURE__*/makeGuard("Boolean");
 /**
  * Narrows an {@link AST} to {@link BigInt}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isBigInt = /*#__PURE__*/makeGuard("BigInt");
 /**
  * Narrows an {@link AST} to {@link Symbol}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isSymbol = /*#__PURE__*/makeGuard("Symbol");
 /**
  * Narrows an {@link AST} to {@link Literal}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export const isLiteral = /*#__PURE__*/makeGuard("Literal");
 /**
  * Narrows an {@link AST} to {@link UniqueSymbol}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export const isUniqueSymbol = /*#__PURE__*/makeGuard("UniqueSymbol");
 /**
  * Narrows an {@link AST} to {@link ObjectKeyword}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export const isObjectKeyword = /*#__PURE__*/makeGuard("ObjectKeyword");
 /**
  * Narrows an {@link AST} to {@link Enum}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isEnum = /*#__PURE__*/makeGuard("Enum");
 /**
  * Narrows an {@link AST} to {@link TemplateLiteral}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export const isTemplateLiteral = /*#__PURE__*/makeGuard("TemplateLiteral");
 /**
  * Narrows an {@link AST} to {@link Arrays}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isArrays = /*#__PURE__*/makeGuard("Arrays");
 /**
  * Narrows an {@link AST} to {@link Objects}.
  *
- * @category Guard
+ * @category guards
  * @since 4.0.0
  */
 export const isObjects = /*#__PURE__*/makeGuard("Objects");
 /**
  * Narrows an {@link AST} to {@link Union}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export const isUnion = /*#__PURE__*/makeGuard("Union");
 /**
  * Narrows an {@link AST} to {@link Suspend}.
  *
- * @category Guard
- * @since 4.0.0
+ * @category guards
+ * @since 3.10.0
  */
 export const isSuspend = /*#__PURE__*/makeGuard("Suspend");
 /**
@@ -267,7 +267,7 @@ export const isSuspend = /*#__PURE__*/makeGuard("Suspend");
  * @see {@link Encoding}
  * @see {@link decodeTo}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Link {
@@ -297,7 +297,7 @@ export const defaultParseOptions = {};
  * @see {@link optionalKey}
  * @see {@link isOptional}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Context {
@@ -331,7 +331,7 @@ const TypeId = "~effect/Schema";
  *
  * @see {@link AST}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Base {
@@ -362,8 +362,8 @@ export class Base {
  *
  * @see {@link isDeclaration}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class Declaration extends Base {
   _tag = "Declaration";
@@ -402,7 +402,7 @@ export class Declaration extends Base {
  * @see {@link null}
  * @see {@link isNull}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Null extends Base {
@@ -432,7 +432,7 @@ null_ as null };
  * @see {@link undefined}
  * @see {@link isUndefined}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Undefined extends Base {
@@ -468,7 +468,7 @@ undefined_ as undefined };
  * @see {@link void}
  * @see {@link isVoid}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Void extends Base {
@@ -503,7 +503,7 @@ void_ as void };
  * @see {@link never}
  * @see {@link isNever}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Never extends Base {
@@ -520,6 +520,7 @@ export class Never extends Base {
 /**
  * Singleton {@link Never} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const never = /*#__PURE__*/new Never();
@@ -529,7 +530,7 @@ export const never = /*#__PURE__*/new Never();
  * @see {@link any}
  * @see {@link isAny}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Any extends Base {
@@ -546,6 +547,7 @@ export class Any extends Base {
 /**
  * Singleton {@link Any} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const any = /*#__PURE__*/new Any();
@@ -558,7 +560,7 @@ export const any = /*#__PURE__*/new Any();
  * @see {@link unknown}
  * @see {@link isUnknown}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Unknown extends Base {
@@ -575,6 +577,7 @@ export class Unknown extends Base {
 /**
  * Singleton {@link Unknown} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const unknown = /*#__PURE__*/new Unknown();
@@ -585,8 +588,8 @@ export const unknown = /*#__PURE__*/new Unknown();
  * @see {@link objectKeyword}
  * @see {@link isObjectKeyword}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class ObjectKeyword extends Base {
   _tag = "ObjectKeyword";
@@ -602,7 +605,8 @@ export class ObjectKeyword extends Base {
 /**
  * Singleton {@link ObjectKeyword} AST instance.
  *
- * @since 4.0.0
+ * @category constructors
+ * @since 3.10.0
  */
 export const objectKeyword = /*#__PURE__*/new ObjectKeyword();
 /**
@@ -613,7 +617,7 @@ export const objectKeyword = /*#__PURE__*/new ObjectKeyword();
  *
  * @see {@link isEnum}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Enum extends Base {
@@ -665,8 +669,8 @@ function isTemplateLiteralPart(ast) {
  *
  * @see {@link isTemplateLiteral}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class TemplateLiteral extends Base {
   _tag = "TemplateLiteral";
@@ -720,8 +724,8 @@ export class TemplateLiteral extends Base {
  *
  * @see {@link isUniqueSymbol}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class UniqueSymbol extends Base {
   _tag = "UniqueSymbol";
@@ -763,8 +767,8 @@ export class UniqueSymbol extends Base {
  * @see {@link LiteralValue}
  * @see {@link isLiteral}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class Literal extends Base {
   _tag = "Literal";
@@ -803,7 +807,7 @@ function literalToString(ast) {
  * @see {@link string}
  * @see {@link isString}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class String extends Base {
@@ -820,6 +824,7 @@ export class String extends Base {
 /**
  * Singleton {@link String} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const string = /*#__PURE__*/new String();
@@ -837,7 +842,7 @@ export const string = /*#__PURE__*/new String();
  * @see {@link number}
  * @see {@link isNumber}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Number extends Base {
@@ -879,6 +884,7 @@ function hasCheck(checks, tag) {
 /**
  * Singleton {@link Number} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const number = /*#__PURE__*/new Number();
@@ -888,7 +894,7 @@ export const number = /*#__PURE__*/new Number();
  * @see {@link boolean}
  * @see {@link isBoolean}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Boolean extends Base {
@@ -905,6 +911,7 @@ export class Boolean extends Base {
 /**
  * Singleton {@link Boolean} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const boolean = /*#__PURE__*/new Boolean();
@@ -917,7 +924,7 @@ export const boolean = /*#__PURE__*/new Boolean();
  * @see {@link symbol}
  * @see {@link isSymbol}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Symbol extends Base {
@@ -938,6 +945,7 @@ export class Symbol extends Base {
 /**
  * Singleton {@link Symbol} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const symbol = /*#__PURE__*/new Symbol();
@@ -950,7 +958,7 @@ export const symbol = /*#__PURE__*/new Symbol();
  * @see {@link bigInt}
  * @see {@link isBigInt}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class BigInt extends Base {
@@ -971,6 +979,7 @@ export class BigInt extends Base {
 /**
  * Singleton {@link BigInt} AST instance.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const bigInt = /*#__PURE__*/new BigInt();
@@ -1006,7 +1015,7 @@ export const bigInt = /*#__PURE__*/new BigInt();
  * @see {@link isArrays}
  * @see {@link Objects}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Arrays extends Base {
@@ -1190,8 +1199,8 @@ export function getIndexSignatureKeys(input, parameter) {
  *
  * @see {@link Objects}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class PropertySignature {
   name;
@@ -1211,7 +1220,7 @@ export class PropertySignature {
  *
  * @see {@link IndexSignature}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class KeyValueCombiner {
@@ -1240,8 +1249,8 @@ export class KeyValueCombiner {
  * @see {@link Objects}
  * @see {@link PropertySignature}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class IndexSignature {
   parameter;
@@ -1257,14 +1266,15 @@ export class IndexSignature {
   }
 }
 /**
- * AST node for object-like types — both structs and records.
+ * AST node for object-like schemas, including structs and records.
  *
  * - `propertySignatures` — named properties with their types (struct fields).
  * - `indexSignatures` — index signature entries (record patterns), each with
- *   a `parameter` AST (the key type) and a `type` AST (the value type).
+ *   a `parameter` AST for matching keys and a `type` AST for values.
  *
- * An `Objects` with no properties and no index signatures acts as a bare
- * `object | array` type check (accepts any non-nullish value).
+ * An `Objects` node with no properties and no index signatures performs only a
+ * non-nullish check: it accepts any value except `null` and `undefined`,
+ * including primitive values.
  *
  * Duplicate property names throw at construction time.
  *
@@ -1289,7 +1299,7 @@ export class IndexSignature {
  * @see {@link IndexSignature}
  * @see {@link Arrays}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Objects extends Base {
@@ -1715,8 +1725,8 @@ export function getCandidates(input, types) {
  *
  * @see {@link isUnion}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class Union extends Base {
   _tag = "Union";
@@ -1865,8 +1875,8 @@ export function memoizeThunk(f) {
  *
  * @see {@link isSuspend}
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class Suspend extends Base {
   _tag = "Suspend";
@@ -1908,7 +1918,7 @@ export class Suspend extends Base {
  * @see {@link Check}
  * @see {@link isPattern}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Filter extends Pipeable.Class {
@@ -1952,7 +1962,7 @@ export class Filter extends Pipeable.Class {
  * @see {@link Filter}
  * @see {@link Check}
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class FilterGroup extends Pipeable.Class {
@@ -1984,12 +1994,15 @@ export function makeFilterByGuard(is, annotations) {
   );
 }
 /**
- * Creates a {@link Filter} that validates strings against a regular expression.
+ * Creates a {@link Filter} that validates strings by running `RegExp.test`.
+ *
+ * The filter can be used with `Schema.filter` or attached directly to a
+ * `String` AST node through checks. The regular expression source is stored in
+ * annotations for serialization and arbitrary generation.
  *
- * - Returns a `Filter<string>` suitable for use with `Schema.filter` or
- *   attached directly to a `String` AST node via checks.
- * - The regex `source` is stored in annotations for serialization and
- *   arbitrary generation.
+ * Use a non-global, non-sticky regular expression, or reset `lastIndex`
+ * yourself, because `RegExp.test` is stateful for expressions with the `g` or
+ * `y` flag.
  *
  * **Example** (Validating an email pattern)
  *
@@ -2001,6 +2014,7 @@ export function makeFilterByGuard(is, annotations) {
  *
  * @see {@link Filter}
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function isPattern(regExp, annotations) {
@@ -2138,6 +2152,7 @@ export const optionalKeyLastLink = /*#__PURE__*/applyToLastLink(optionalKey);
  * @see {@link isOptional}
  * @see {@link Context}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export function optionalKey(ast) {
@@ -2172,6 +2187,7 @@ export function withConstructorDefault(ast, defaultValue) {
  * @see {@link Encoding}
  * @see {@link flip}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export function decodeTo(from, to, transformation) {
@@ -2236,6 +2252,7 @@ export function record(key, value, keyValueCombiner) {
  * @see {@link optionalKey}
  * @see {@link Context}
  *
+ * @category predicates
  * @since 4.0.0
  */
 export function isOptional(ast) {
@@ -2267,6 +2284,7 @@ export function isMutable(ast) {
  * @see {@link toEncoded}
  * @see {@link flip}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export const toType = /*#__PURE__*/memoize(ast => {
@@ -2299,6 +2317,7 @@ export const toType = /*#__PURE__*/memoize(ast => {
  * @see {@link toType}
  * @see {@link flip}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export const toEncoded = /*#__PURE__*/memoize(ast => {
@@ -2333,6 +2352,7 @@ function flipEncoding(ast, encoding) {
  * @see {@link toType}
  * @see {@link toEncoded}
  *
+ * @category transforming
  * @since 4.0.0
  */
 export const flip = /*#__PURE__*/memoize(ast => {
@@ -2564,6 +2584,7 @@ export const STRUCTURAL_ANNOTATION_KEY = "~structural";
  * @see {@link resolveTitle}
  * @see {@link resolveDescription}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export const resolve = InternalAnnotations.resolve;
@@ -2575,6 +2596,7 @@ export const resolve = InternalAnnotations.resolve;
  *
  * @see {@link resolve}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export const resolveAt = InternalAnnotations.resolveAt;
@@ -2587,6 +2609,7 @@ export const resolveAt = InternalAnnotations.resolveAt;
  * @see {@link resolve}
  * @see {@link resolveTitle}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export const resolveIdentifier = InternalAnnotations.resolveIdentifier;
@@ -2597,6 +2620,7 @@ export const resolveIdentifier = InternalAnnotations.resolveIdentifier;
  * @see {@link resolveIdentifier}
  * @see {@link resolveDescription}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export const resolveTitle = InternalAnnotations.resolveTitle;
@@ -2607,6 +2631,7 @@ export const resolveTitle = InternalAnnotations.resolveTitle;
  * @see {@link resolveTitle}
  * @see {@link resolveIdentifier}
  *
+ * @category annotations
  * @since 4.0.0
  */
 export const resolveDescription = InternalAnnotations.resolveDescription;