effect 4.0.0-beta.66 → 4.0.0-beta.67

package/dist/Boolean.d.ts

@@ -11,7 +11,8 @@ import * as Reducer from "./Reducer.ts";
 /**
  * Reference to the global Boolean constructor.
  *
- * @example
+ * **Example** (Coercing values to booleans)
+ *
  * ```ts
  * import * as Boolean from "effect/Boolean"
  *
@@ -32,7 +33,8 @@ export declare const Boolean: BooleanConstructor;
 /**
  * Tests if a value is a `boolean`.
  *
- * @example
+ * **Example** (Checking for booleans)
+ *
  * ```ts
  * import { isBoolean } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -49,7 +51,8 @@ export declare const isBoolean: (input: unknown) => input is boolean;
  * This function returns the result of either of the given functions depending on the value of the boolean parameter.
  * It is useful when you have to run one of two functions depending on the boolean value.
  *
- * @example
+ * **Example** (Pattern matching on booleans)
+ *
  * ```ts
  * import * as Boolean from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -71,7 +74,8 @@ export declare const match: {
      * This function returns the result of either of the given functions depending on the value of the boolean parameter.
      * It is useful when you have to run one of two functions depending on the boolean value.
      *
-     * @example
+     * **Example** (Pattern matching on booleans)
+     *
      * ```ts
      * import * as Boolean from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -96,7 +100,8 @@ export declare const match: {
      * This function returns the result of either of the given functions depending on the value of the boolean parameter.
      * It is useful when you have to run one of two functions depending on the boolean value.
      *
-     * @example
+     * **Example** (Pattern matching on booleans)
+     *
      * ```ts
      * import * as Boolean from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -122,7 +127,8 @@ export declare const match: {
  * Provides an `Order` instance for `boolean` that allows comparing and sorting boolean values.
  * In this ordering, `false` is considered less than `true`.
  *
- * @example
+ * **Example** (Comparing booleans)
+ *
  * ```ts
  * import * as Boolean from "effect/Boolean"
  *
@@ -138,7 +144,8 @@ export declare const Order: order.Order<boolean>;
 /**
  * An `Equivalence` instance for booleans using strict equality (`===`).
  *
- * @example
+ * **Example** (Comparing booleans for equivalence)
+ *
  * ```ts
  * import { Boolean } from "effect"
  *
@@ -153,7 +160,8 @@ export declare const Equivalence: Equ.Equivalence<boolean>;
 /**
  * Negates the given boolean: `!self`
  *
- * @example
+ * **Example** (Negating booleans)
+ *
  * ```ts
  * import { not } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -169,7 +177,8 @@ export declare const not: (self: boolean) => boolean;
 /**
  * Combines two boolean using AND: `self && that`.
  *
- * @example
+ * **Example** (Combining booleans with AND)
+ *
  * ```ts
  * import { and } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -187,7 +196,8 @@ export declare const and: {
     /**
      * Combines two boolean using AND: `self && that`.
      *
-     * @example
+     * **Example** (Combining booleans with AND)
+     *
      * ```ts
      * import { and } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -205,7 +215,8 @@ export declare const and: {
     /**
      * Combines two boolean using AND: `self && that`.
      *
-     * @example
+     * **Example** (Combining booleans with AND)
+     *
      * ```ts
      * import { and } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -224,7 +235,8 @@ export declare const and: {
 /**
  * Combines two boolean using NAND: `!(self && that)`.
  *
- * @example
+ * **Example** (Combining booleans with NAND)
+ *
  * ```ts
  * import { nand } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -242,7 +254,8 @@ export declare const nand: {
     /**
      * Combines two boolean using NAND: `!(self && that)`.
      *
-     * @example
+     * **Example** (Combining booleans with NAND)
+     *
      * ```ts
      * import { nand } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -260,7 +273,8 @@ export declare const nand: {
     /**
      * Combines two boolean using NAND: `!(self && that)`.
      *
-     * @example
+     * **Example** (Combining booleans with NAND)
+     *
      * ```ts
      * import { nand } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -279,7 +293,8 @@ export declare const nand: {
 /**
  * Combines two boolean using OR: `self || that`.
  *
- * @example
+ * **Example** (Combining booleans with OR)
+ *
  * ```ts
  * import { or } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -297,7 +312,8 @@ export declare const or: {
     /**
      * Combines two boolean using OR: `self || that`.
      *
-     * @example
+     * **Example** (Combining booleans with OR)
+     *
      * ```ts
      * import { or } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -315,7 +331,8 @@ export declare const or: {
     /**
      * Combines two boolean using OR: `self || that`.
      *
-     * @example
+     * **Example** (Combining booleans with OR)
+     *
      * ```ts
      * import { or } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -334,7 +351,8 @@ export declare const or: {
 /**
  * Combines two booleans using NOR: `!(self || that)`.
  *
- * @example
+ * **Example** (Combining booleans with NOR)
+ *
  * ```ts
  * import { nor } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -352,7 +370,8 @@ export declare const nor: {
     /**
      * Combines two booleans using NOR: `!(self || that)`.
      *
-     * @example
+     * **Example** (Combining booleans with NOR)
+     *
      * ```ts
      * import { nor } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -370,7 +389,8 @@ export declare const nor: {
     /**
      * Combines two booleans using NOR: `!(self || that)`.
      *
-     * @example
+     * **Example** (Combining booleans with NOR)
+     *
      * ```ts
      * import { nor } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -389,7 +409,8 @@ export declare const nor: {
 /**
  * Combines two booleans using XOR: `(!self && that) || (self && !that)`.
  *
- * @example
+ * **Example** (Combining booleans with XOR)
+ *
  * ```ts
  * import { xor } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -407,7 +428,8 @@ export declare const xor: {
     /**
      * Combines two booleans using XOR: `(!self && that) || (self && !that)`.
      *
-     * @example
+     * **Example** (Combining booleans with XOR)
+     *
      * ```ts
      * import { xor } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -425,7 +447,8 @@ export declare const xor: {
     /**
      * Combines two booleans using XOR: `(!self && that) || (self && !that)`.
      *
-     * @example
+     * **Example** (Combining booleans with XOR)
+     *
      * ```ts
      * import { xor } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -444,7 +467,8 @@ export declare const xor: {
 /**
  * Combines two booleans using EQV (aka XNOR): `!xor(self, that)`.
  *
- * @example
+ * **Example** (Checking boolean equivalence)
+ *
  * ```ts
  * import { eqv } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -462,7 +486,8 @@ export declare const eqv: {
     /**
      * Combines two booleans using EQV (aka XNOR): `!xor(self, that)`.
      *
-     * @example
+     * **Example** (Checking boolean equivalence)
+     *
      * ```ts
      * import { eqv } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -480,7 +505,8 @@ export declare const eqv: {
     /**
      * Combines two booleans using EQV (aka XNOR): `!xor(self, that)`.
      *
-     * @example
+     * **Example** (Checking boolean equivalence)
+     *
      * ```ts
      * import { eqv } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -499,7 +525,8 @@ export declare const eqv: {
 /**
  * Combines two booleans using an implication: `(!self || that)`.
  *
- * @example
+ * **Example** (Checking boolean implication)
+ *
  * ```ts
  * import { implies } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -517,7 +544,8 @@ export declare const implies: {
     /**
      * Combines two booleans using an implication: `(!self || that)`.
      *
-     * @example
+     * **Example** (Checking boolean implication)
+     *
      * ```ts
      * import { implies } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -535,7 +563,8 @@ export declare const implies: {
     /**
      * Combines two booleans using an implication: `(!self || that)`.
      *
-     * @example
+     * **Example** (Checking boolean implication)
+     *
      * ```ts
      * import { implies } from "effect/Boolean"
      * import * as assert from "node:assert"
@@ -554,7 +583,8 @@ export declare const implies: {
 /**
  * This utility function is used to check if all the elements in a collection of boolean values are `true`.
  *
- * @example
+ * **Example** (Checking every boolean)
+ *
  * ```ts
  * import { every } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -570,7 +600,8 @@ export declare const every: (collection: Iterable<boolean>) => boolean;
 /**
  * This utility function is used to check if at least one of the elements in a collection of boolean values is `true`.
  *
- * @example
+ * **Example** (Checking some booleans)
+ *
  * ```ts
  * import { some } from "effect/Boolean"
  * import * as assert from "node:assert"

package/dist/Boolean.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Boolean.d.ts","sourceRoot":"","sources":["../src/Boolean.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,OAAO,oBAAqB,CAAA;AAEzC;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAA6B,CAAA;AAElF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EACR,OAAO,EAAE;QACP,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;KAC5B,GACC,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,CAAC,CAAC,EAAE,CAAC,EACJ,KAAK,EAAE,OAAO,EACd,OAAO,EAAE;QACP,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;KAC5B,GACC,CAAC,GAAG,CAAC,CAAA;CAIgD,CAAA;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAiB,CAAA;AAExD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,OAAO,CAAe,CAAA;AAEhE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,GAAG,GAAI,MAAM,OAAO,KAAG,OAAgB,CAAA;AAEpD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC2B,CAAA;AAEpE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC8B,CAAA;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,EAAE,EAAE;IACf;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC2B,CAAA;AAEpE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC8B,CAAA;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CACiD,CAAA;AAE1F;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC+B,CAAA;AAExE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CACM,CAAA;AAE/C;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,KAAK,GAAI,YAAY,QAAQ,CAAC,OAAO,CAAC,KAAG,OAOrD,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,IAAI,GAAI,YAAY,QAAQ,CAAC,OAAO,CAAC,KAAG,OAOpD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAwC,CAAA;AAExF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAyC,CAAA"}
+{"version":3,"file":"Boolean.d.ts","sourceRoot":"","sources":["../src/Boolean.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,OAAO,oBAAqB,CAAA;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAA6B,CAAA;AAElF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EACR,OAAO,EAAE;QACP,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;KAC5B,GACC,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EACJ,KAAK,EAAE,OAAO,EACd,OAAO,EAAE;QACP,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;KAC5B,GACC,CAAC,GAAG,CAAC,CAAA;CAIgD,CAAA;AAE1D;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAiB,CAAA;AAExD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,OAAO,CAAe,CAAA;AAEhE;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,GAAG,GAAI,MAAM,OAAO,KAAG,OAAgB,CAAA;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC2B,CAAA;AAEpE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC8B,CAAA;AAEvE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,EAAE,EAAE;IACf;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC2B,CAAA;AAEpE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC8B,CAAA;AAEvE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CACiD,CAAA;AAE1F;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CAC+B,CAAA;AAExE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;CACM,CAAA;AAE/C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,KAAK,GAAI,YAAY,QAAQ,CAAC,OAAO,CAAC,KAAG,OAOrD,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,IAAI,GAAI,YAAY,QAAQ,CAAC,OAAO,CAAC,KAAG,OAOpD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAwC,CAAA;AAExF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAyC,CAAA"}

package/dist/Boolean.js

@@ -12,7 +12,8 @@ import * as Reducer from "./Reducer.js";
 /**
  * Reference to the global Boolean constructor.
  *
- * @example
+ * **Example** (Coercing values to booleans)
+ *
  * ```ts
  * import * as Boolean from "effect/Boolean"
  *
@@ -33,7 +34,8 @@ export const Boolean = globalThis.Boolean;
 /**
  * Tests if a value is a `boolean`.
  *
- * @example
+ * **Example** (Checking for booleans)
+ *
  * ```ts
  * import { isBoolean } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -50,7 +52,8 @@ export const isBoolean = predicate.isBoolean;
  * This function returns the result of either of the given functions depending on the value of the boolean parameter.
  * It is useful when you have to run one of two functions depending on the boolean value.
  *
- * @example
+ * **Example** (Pattern matching on booleans)
+ *
  * ```ts
  * import * as Boolean from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -72,7 +75,8 @@ export const match = /*#__PURE__*/dual(2, (value, options) => value ? options.on
  * Provides an `Order` instance for `boolean` that allows comparing and sorting boolean values.
  * In this ordering, `false` is considered less than `true`.
  *
- * @example
+ * **Example** (Comparing booleans)
+ *
  * ```ts
  * import * as Boolean from "effect/Boolean"
  *
@@ -88,7 +92,8 @@ export const Order = order.Boolean;
 /**
  * An `Equivalence` instance for booleans using strict equality (`===`).
  *
- * @example
+ * **Example** (Comparing booleans for equivalence)
+ *
  * ```ts
  * import { Boolean } from "effect"
  *
@@ -103,7 +108,8 @@ export const Equivalence = Equ.Boolean;
 /**
  * Negates the given boolean: `!self`
  *
- * @example
+ * **Example** (Negating booleans)
+ *
  * ```ts
  * import { not } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -119,7 +125,8 @@ export const not = self => !self;
 /**
  * Combines two boolean using AND: `self && that`.
  *
- * @example
+ * **Example** (Combining booleans with AND)
+ *
  * ```ts
  * import { and } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -137,7 +144,8 @@ export const and = /*#__PURE__*/dual(2, (self, that) => self && that);
 /**
  * Combines two boolean using NAND: `!(self && that)`.
  *
- * @example
+ * **Example** (Combining booleans with NAND)
+ *
  * ```ts
  * import { nand } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -155,7 +163,8 @@ export const nand = /*#__PURE__*/dual(2, (self, that) => !(self && that));
 /**
  * Combines two boolean using OR: `self || that`.
  *
- * @example
+ * **Example** (Combining booleans with OR)
+ *
  * ```ts
  * import { or } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -173,7 +182,8 @@ export const or = /*#__PURE__*/dual(2, (self, that) => self || that);
 /**
  * Combines two booleans using NOR: `!(self || that)`.
  *
- * @example
+ * **Example** (Combining booleans with NOR)
+ *
  * ```ts
  * import { nor } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -191,7 +201,8 @@ export const nor = /*#__PURE__*/dual(2, (self, that) => !(self || that));
 /**
  * Combines two booleans using XOR: `(!self && that) || (self && !that)`.
  *
- * @example
+ * **Example** (Combining booleans with XOR)
+ *
  * ```ts
  * import { xor } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -209,7 +220,8 @@ export const xor = /*#__PURE__*/dual(2, (self, that) => !self && that || self &&
 /**
  * Combines two booleans using EQV (aka XNOR): `!xor(self, that)`.
  *
- * @example
+ * **Example** (Checking boolean equivalence)
+ *
  * ```ts
  * import { eqv } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -227,7 +239,8 @@ export const eqv = /*#__PURE__*/dual(2, (self, that) => !xor(self, that));
 /**
  * Combines two booleans using an implication: `(!self || that)`.
  *
- * @example
+ * **Example** (Checking boolean implication)
+ *
  * ```ts
  * import { implies } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -245,7 +258,8 @@ export const implies = /*#__PURE__*/dual(2, (self, that) => self ? that : true);
 /**
  * This utility function is used to check if all the elements in a collection of boolean values are `true`.
  *
- * @example
+ * **Example** (Checking every boolean)
+ *
  * ```ts
  * import { every } from "effect/Boolean"
  * import * as assert from "node:assert"
@@ -268,7 +282,8 @@ export const every = collection => {
 /**
  * This utility function is used to check if at least one of the elements in a collection of boolean values is `true`.
  *
- * @example
+ * **Example** (Checking some booleans)
+ *
  * ```ts
  * import { some } from "effect/Boolean"
  * import * as assert from "node:assert"

package/dist/Boolean.js.map

@@ -1 +1 @@
-{"version":3,"file":"Boolean.js","names":["Equ","dual","order","predicate","Reducer","Boolean","globalThis","isBoolean","match","value","options","onTrue","onFalse","Order","Equivalence","not","self","and","that","nand","or","nor","xor","eqv","implies","every","collection","b","some","ReducerAnd","make","a","ReducerOr"],"sources":["../src/Boolean.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;AAMA,OAAO,KAAKA,GAAG,MAAM,kBAAkB;AAEvC,SAASC,IAAI,QAAQ,eAAe;AACpC,OAAO,KAAKC,KAAK,MAAM,YAAY;AACnC,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAC3C,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMC,OAAO,GAAGC,UAAU,CAACD,OAAO;AAEzC;;;;;;;;;;;;;;;AAeA,OAAO,MAAME,SAAS,GAAyCJ,SAAS,CAACI,SAAS;AAElF;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,MAAMC,KAAK,gBAwDdP,IAAI,CAAC,CAAC,EAAE,CAAOQ,KAAc,EAAEC,OAGlC,KAAYD,KAAK,GAAGC,OAAO,CAACC,MAAM,EAAE,GAAGD,OAAO,CAACE,OAAO,EAAE,CAAC;AAE1D;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMC,KAAK,GAAyBX,KAAK,CAACG,OAAO;AAExD;;;;;;;;;;;;;;AAcA,OAAO,MAAMS,WAAW,GAA6Bd,GAAG,CAACK,OAAO;AAEhE;;;;;;;;;;;;;;;AAeA,OAAO,MAAMU,GAAG,GAAIC,IAAa,IAAc,CAACA,IAAI;AAEpD;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMC,GAAG,gBAqCZhB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAcF,IAAI,IAAIE,IAAI,CAAC;AAEpE;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMC,IAAI,gBAqCblB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAc,EAAEF,IAAI,IAAIE,IAAI,CAAC,CAAC;AAEvE;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAME,EAAE,gBAqCXnB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAcF,IAAI,IAAIE,IAAI,CAAC;AAEpE;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMG,GAAG,gBAqCZpB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAc,EAAEF,IAAI,IAAIE,IAAI,CAAC,CAAC;AAEvE;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMI,GAAG,gBAqCZrB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAe,CAACF,IAAI,IAAIE,IAAI,IAAMF,IAAI,IAAI,CAACE,IAAK,CAAC;AAE1F;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMK,GAAG,gBAqCZtB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAc,CAACI,GAAG,CAACN,IAAI,EAAEE,IAAI,CAAC,CAAC;AAExE;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMM,OAAO,gBAqChBvB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAI,EAAEE,IAAI,KAAKF,IAAI,GAAGE,IAAI,GAAG,IAAI,CAAC;AAE/C;;;;;;;;;;;;;;;AAeA,OAAO,MAAMO,KAAK,GAAIC,UAA6B,IAAa;EAC9D,KAAK,MAAMC,CAAC,IAAID,UAAU,EAAE;IAC1B,IAAI,CAACC,CAAC,EAAE;MACN,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb,CAAC;AAED;;;;;;;;;;;;;;;AAeA,OAAO,MAAMC,IAAI,GAAIF,UAA6B,IAAa;EAC7D,KAAK,MAAMC,CAAC,IAAID,UAAU,EAAE;IAC1B,IAAIC,CAAC,EAAE;MACL,OAAO,IAAI;IACb;EACF;EACA,OAAO,KAAK;AACd,CAAC;AAED;;;;;;;AAOA,OAAO,MAAME,UAAU,gBAA6BzB,OAAO,CAAC0B,IAAI,CAAC,CAACC,CAAC,EAAEJ,CAAC,KAAKI,CAAC,IAAIJ,CAAC,EAAE,IAAI,CAAC;AAExF;;;;;;;AAOA,OAAO,MAAMK,SAAS,gBAA6B5B,OAAO,CAAC0B,IAAI,CAAC,CAACC,CAAC,EAAEJ,CAAC,KAAKI,CAAC,IAAIJ,CAAC,EAAE,KAAK,CAAC","ignoreList":[]}
+{"version":3,"file":"Boolean.js","names":["Equ","dual","order","predicate","Reducer","Boolean","globalThis","isBoolean","match","value","options","onTrue","onFalse","Order","Equivalence","not","self","and","that","nand","or","nor","xor","eqv","implies","every","collection","b","some","ReducerAnd","make","a","ReducerOr"],"sources":["../src/Boolean.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;AAMA,OAAO,KAAKA,GAAG,MAAM,kBAAkB;AAEvC,SAASC,IAAI,QAAQ,eAAe;AACpC,OAAO,KAAKC,KAAK,MAAM,YAAY;AACnC,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAC3C,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,MAAMC,OAAO,GAAGC,UAAU,CAACD,OAAO;AAEzC;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAME,SAAS,GAAyCJ,SAAS,CAACI,SAAS;AAElF;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMC,KAAK,gBA0DdP,IAAI,CAAC,CAAC,EAAE,CAAOQ,KAAc,EAAEC,OAGlC,KAAYD,KAAK,GAAGC,OAAO,CAACC,MAAM,EAAE,GAAGD,OAAO,CAACE,OAAO,EAAE,CAAC;AAE1D;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMC,KAAK,GAAyBX,KAAK,CAACG,OAAO;AAExD;;;;;;;;;;;;;;;AAeA,OAAO,MAAMS,WAAW,GAA6Bd,GAAG,CAACK,OAAO;AAEhE;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMU,GAAG,GAAIC,IAAa,IAAc,CAACA,IAAI;AAEpD;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,GAAG,gBAuCZhB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAcF,IAAI,IAAIE,IAAI,CAAC;AAEpE;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,IAAI,gBAuCblB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAc,EAAEF,IAAI,IAAIE,IAAI,CAAC,CAAC;AAEvE;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAME,EAAE,gBAuCXnB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAcF,IAAI,IAAIE,IAAI,CAAC;AAEpE;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMG,GAAG,gBAuCZpB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAc,EAAEF,IAAI,IAAIE,IAAI,CAAC,CAAC;AAEvE;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMI,GAAG,gBAuCZrB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAe,CAACF,IAAI,IAAIE,IAAI,IAAMF,IAAI,IAAI,CAACE,IAAK,CAAC;AAE1F;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMK,GAAG,gBAuCZtB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAa,EAAEE,IAAa,KAAc,CAACI,GAAG,CAACN,IAAI,EAAEE,IAAI,CAAC,CAAC;AAExE;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMM,OAAO,gBAuChBvB,IAAI,CAAC,CAAC,EAAE,CAACe,IAAI,EAAEE,IAAI,KAAKF,IAAI,GAAGE,IAAI,GAAG,IAAI,CAAC;AAE/C;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMO,KAAK,GAAIC,UAA6B,IAAa;EAC9D,KAAK,MAAMC,CAAC,IAAID,UAAU,EAAE;IAC1B,IAAI,CAACC,CAAC,EAAE;MACN,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb,CAAC;AAED;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMC,IAAI,GAAIF,UAA6B,IAAa;EAC7D,KAAK,MAAMC,CAAC,IAAID,UAAU,EAAE;IAC1B,IAAIC,CAAC,EAAE;MACL,OAAO,IAAI;IACb;EACF;EACA,OAAO,KAAK;AACd,CAAC;AAED;;;;;;;AAOA,OAAO,MAAME,UAAU,gBAA6BzB,OAAO,CAAC0B,IAAI,CAAC,CAACC,CAAC,EAAEJ,CAAC,KAAKI,CAAC,IAAIJ,CAAC,EAAE,IAAI,CAAC;AAExF;;;;;;;AAOA,OAAO,MAAMK,SAAS,gBAA6B5B,OAAO,CAAC0B,IAAI,CAAC,CAACC,CAAC,EAAEJ,CAAC,KAAKI,CAAC,IAAIJ,CAAC,EAAE,KAAK,CAAC","ignoreList":[]}

package/dist/Brand.d.ts

@@ -8,8 +8,8 @@ declare const TypeId = "~effect/Brand";
 /**
  * A generic interface that defines a branded type.
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface Brand<in out Keys extends string> {
     readonly [TypeId]: {
@@ -56,27 +56,40 @@ export interface Constructor<in out B extends Brand<any>> {
 export declare class BrandError {
     constructor(issue: Issue.Issue);
     /**
+     * Discriminant used to identify brand construction failures.
+     *
      * @since 4.0.0
      */
     readonly _tag = "BrandError";
     /**
+     * Error name used by tools that inspect JavaScript error-like objects.
+     *
      * @since 4.0.0
      */
     readonly name: string;
     /**
+     * Schema issue describing why brand validation failed.
+     *
      * @since 4.0.0
      */
     readonly issue: Issue.Issue;
     /**
+     * Human-readable rendering of the validation issue.
+     *
      * @since 4.0.0
      */
     get message(): string;
     /**
+     * Formats the brand error together with its validation message.
+     *
      * @since 4.0.0
      */
     toString(): string;
 }
 /**
+ * Namespace containing type-level helpers for working with branded types and
+ * brand constructors.
+ *
  * @since 2.0.0
  */
 export declare namespace Brand {
@@ -148,6 +161,12 @@ export declare function nominal<A extends Brand<any>>(): Constructor<A>;
  */
 export declare function make<A extends Brand<any>>(filter: (unbranded: Brand.Unbranded<A>) => Schema.FilterOutput): Constructor<A>;
 /**
+ * Creates a branded type `Constructor` from one or more schema checks.
+ *
+ * Calling the returned constructor validates the unbranded value and throws on
+ * failure. Use the returned `option`, `result`, or `is` methods for
+ * non-throwing validation.
+ *
  * @since 4.0.0
  */
 export declare function check<A extends Brand<any>>(...checks: readonly [

package/dist/Brand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Brand.d.ts","sourceRoot":"","sources":["../src/Brand.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAA;AACrC,OAAO,KAAK,KAAK,KAAK,MAAM,kBAAkB,CAAA;AAC9C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,QAAA,MAAM,MAAM,kBAAkB,CAAA;AAE9B;;;;;GAKG;AACH,MAAM,WAAW,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,SAAS,MAAM;IAC/C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,EAAE,CAAC,IAAI,IAAI,GAAG,IAAI;KAC3B,CAAA;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC;IACtD;;;OAGG;IACH,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IAClC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACvD;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;IACnE;;;OAGG;IACH,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAQvE;AAED;;;;;;GAMG;AACH,qBAAa,UAAU;gBACT,KAAK,EAAE,KAAK,CAAC,KAAK;IAG9B;;OAEG;IACH,QAAQ,CAAC,IAAI,gBAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAe;IACpC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAA;IAC3B;;OAEG;IACH,IAAI,OAAO,WAEV;IACD;;OAEG;IACH,QAAQ;CAGT;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B;;;;OAIG;IACH,KAAY,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAE3E;;;;OAIG;IACH,KAAY,SAAS,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAEnF;;;;OAIG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,OAAO,MAAM,CAAC,CAAA;IAE/D;;;;OAIG;IACH,KAAY,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAClE;SAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK;KAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CACjE,CAAA;IAED;;;;OAIG;IACH,KAAY,gBAAgB,CAC1B,MAAM,SAAS,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IACpE;SACD,CAAC,IAAI,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SACpE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GACzG,MAAM,CAAC,CAAC,CAAC,GACX,MAAM,CAAC,CAAC,CAAC,GACT,kDAAkD;KACvD,CAAA;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;AAE3D;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAM9D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EACvC,MAAM,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,YAAY,GAC7D,WAAW,CAAC,CAAC,CAAC,CAEhB;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EACxC,GAAG,MAAM,EAAE,SAAS;IAClB,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC7B,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;CACxC,GACA,WAAW,CAAC,CAAC,CAAC,CAUhB;AAED;;;;;;;GAOG;AACH,wBAAgB,GAAG,CAAC,MAAM,SAAS,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EACxF,GAAG,MAAM,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,GACxC,WAAW,CACZ,KAAK,CAAC,mBAAmB,CAAC;KAAG,CAAC,IAAI,MAAM,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,MAAM,CAAC,CAAC,SAC1F,MAAM,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAC9C,CAKA"}
+{"version":3,"file":"Brand.d.ts","sourceRoot":"","sources":["../src/Brand.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAA;AACrC,OAAO,KAAK,KAAK,KAAK,MAAM,kBAAkB,CAAA;AAC9C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,QAAA,MAAM,MAAM,kBAAkB,CAAA;AAE9B;;;;;GAKG;AACH,MAAM,WAAW,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,SAAS,MAAM;IAC/C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,EAAE,CAAC,IAAI,IAAI,GAAG,IAAI;KAC3B,CAAA;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC;IACtD;;;OAGG;IACH,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IAClC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACvD;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;IACnE;;;OAGG;IACH,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAQvE;AAED;;;;;;GAMG;AACH,qBAAa,UAAU;gBACT,KAAK,EAAE,KAAK,CAAC,KAAK;IAG9B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,gBAAe;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAe;IACpC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAA;IAC3B;;;;OAIG;IACH,IAAI,OAAO,WAEV;IACD;;;;OAIG;IACH,QAAQ;CAGT;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B;;;;OAIG;IACH,KAAY,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAE3E;;;;OAIG;IACH,KAAY,SAAS,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAEnF;;;;OAIG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,OAAO,MAAM,CAAC,CAAA;IAE/D;;;;OAIG;IACH,KAAY,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAClE;SAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK;KAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CACjE,CAAA;IAED;;;;OAIG;IACH,KAAY,gBAAgB,CAC1B,MAAM,SAAS,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IACpE;SACD,CAAC,IAAI,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SACpE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GACzG,MAAM,CAAC,CAAC,CAAC,GACX,MAAM,CAAC,CAAC,CAAC,GACT,kDAAkD;KACvD,CAAA;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;AAE3D;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAM9D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EACvC,MAAM,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,YAAY,GAC7D,WAAW,CAAC,CAAC,CAAC,CAEhB;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EACxC,GAAG,MAAM,EAAE,SAAS;IAClB,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC7B,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;CACxC,GACA,WAAW,CAAC,CAAC,CAAC,CAUhB;AAED;;;;;;;GAOG;AACH,wBAAgB,GAAG,CAAC,MAAM,SAAS,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EACxF,GAAG,MAAM,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,GACxC,WAAW,CACZ,KAAK,CAAC,mBAAmB,CAAC;KAAG,CAAC,IAAI,MAAM,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,MAAM,CAAC,CAAC,SAC1F,MAAM,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAC9C,CAKA"}

package/dist/Brand.js

@@ -22,24 +22,34 @@ export class BrandError {
     this.issue = issue;
   }
   /**
+   * Discriminant used to identify brand construction failures.
+   *
    * @since 4.0.0
    */
   _tag = "BrandError";
   /**
+   * Error name used by tools that inspect JavaScript error-like objects.
+   *
    * @since 4.0.0
    */
   name = "BrandError";
   /**
+   * Schema issue describing why brand validation failed.
+   *
    * @since 4.0.0
    */
   issue;
   /**
+   * Human-readable rendering of the validation issue.
+   *
    * @since 4.0.0
    */
   get message() {
     return this.issue.toString();
   }
   /**
+   * Formats the brand error together with its validation message.
+   *
    * @since 4.0.0
    */
   toString() {
@@ -80,6 +90,12 @@ export function make(filter) {
   return check(AST.makeFilter(filter));
 }
 /**
+ * Creates a branded type `Constructor` from one or more schema checks.
+ *
+ * Calling the returned constructor validates the unbranded value and throws on
+ * failure. Use the returned `option`, `result`, or `is` methods for
+ * non-throwing validation.
+ *
  * @since 4.0.0
  */
 export function check(...checks) {

package/dist/Brand.js.map

@@ -1 +1 @@
-{"version":3,"file":"Brand.js","names":["Arr","Option","Result","AST","TypeId","BrandError","constructor","issue","_tag","name","message","toString","nominal","Object","assign","input","option","some","result","succeed","is","_","make","filter","check","makeFilter","checks","mapError","runChecks","getOrThrow","getSuccess","isSuccess","all","brands","flatMap","brand","isArrayNonEmpty"],"sources":["../src/Brand.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AAOA,OAAO,KAAKA,GAAG,MAAM,YAAY;AACjC,OAAO,KAAKC,MAAM,MAAM,aAAa;AACrC,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC,OAAO,KAAKC,GAAG,MAAM,gBAAgB;AAIrC,MAAMC,MAAM,GAAG,eAAe;AAoD9B;;;;;;;AAOA,OAAM,MAAOC,UAAU;EACrBC,YAAYC,KAAkB;IAC5B,IAAI,CAACA,KAAK,GAAGA,KAAK;EACpB;EACA;;;EAGSC,IAAI,GAAG,YAAY;EAC5B;;;EAGSC,IAAI,GAAW,YAAY;EACpC;;;EAGSF,KAAK;EACd;;;EAGA,IAAIG,OAAOA,CAAA;IACT,OAAO,IAAI,CAACH,KAAK,CAACI,QAAQ,EAAE;EAC9B;EACA;;;EAGAA,QAAQA,CAAA;IACN,OAAO,cAAc,IAAI,CAACD,OAAO,GAAG;EACtC;;AA8DF;;;;;;;;;;;;AAYA,OAAM,SAAUE,OAAOA,CAAA;EACrB,OAAOC,MAAM,CAACC,MAAM,CAAEC,KAAyB,IAAKA,KAAU,EAAE;IAC9DC,MAAM,EAAGD,KAAyB,IAAKd,MAAM,CAACgB,IAAI,CAACF,KAAU,CAAC;IAC9DG,MAAM,EAAGH,KAAyB,IAAKb,MAAM,CAACiB,OAAO,CAACJ,KAAU,CAAC;IACjEK,EAAE,EAAGC,CAAqB,IAAkC;GAC7D,CAAC;AACJ;AAEA;;;;;;;;;;;AAWA,OAAM,SAAUC,IAAIA,CAClBC,MAA8D;EAE9D,OAAOC,KAAK,CAACrB,GAAG,CAACsB,UAAU,CAACF,MAAM,CAAC,CAAC;AACtC;AAEA;;;AAGA,OAAM,SAAUC,KAAKA,CACnB,GAAGE,MAGF;EAED,MAAMR,MAAM,GAAIH,KAAyB,IAAkC;IACzE,OAAOb,MAAM,CAACyB,QAAQ,CAACxB,GAAG,CAACyB,SAAS,CAACF,MAAM,EAAEX,KAAK,CAAC,EAAGR,KAAK,IAAK,IAAIF,UAAU,CAACE,KAAK,CAAC,CAAQ;EAC/F,CAAC;EACD,OAAOM,MAAM,CAACC,MAAM,CAAEC,KAAyB,IAAKb,MAAM,CAAC2B,UAAU,CAACX,MAAM,CAACH,KAAK,CAAC,CAAC,EAAE;IACpFC,MAAM,EAAGD,KAAyB,IAAKd,MAAM,CAAC6B,UAAU,CAACZ,MAAM,CAACH,KAAK,CAAC,CAAC;IACvEG,MAAM;IACNE,EAAE,EAAGL,KAAyB,IAAsCb,MAAM,CAAC6B,SAAS,CAACb,MAAM,CAACH,KAAK,CAAC,CAAC;IACnGW;GACD,CAAC;AACJ;AAEA;;;;;;;;AAQA,OAAM,SAAUM,GAAGA,CACjB,GAAGC,MAAsC;EAKzC,MAAMP,MAAM,GAAGO,MAAM,CAACC,OAAO,CAAEC,KAAK,IAAKA,KAAK,CAACT,MAAM,IAAI,EAAE,CAAC;EAC5D,OAAO1B,GAAG,CAACoC,eAAe,CAACV,MAAM,CAAC,GAChCF,KAAK,CAAC,GAAGE,MAAM,CAAC,GAChBd,OAAO,EAAE;AACb","ignoreList":[]}
+{"version":3,"file":"Brand.js","names":["Arr","Option","Result","AST","TypeId","BrandError","constructor","issue","_tag","name","message","toString","nominal","Object","assign","input","option","some","result","succeed","is","_","make","filter","check","makeFilter","checks","mapError","runChecks","getOrThrow","getSuccess","isSuccess","all","brands","flatMap","brand","isArrayNonEmpty"],"sources":["../src/Brand.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AAOA,OAAO,KAAKA,GAAG,MAAM,YAAY;AACjC,OAAO,KAAKC,MAAM,MAAM,aAAa;AACrC,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC,OAAO,KAAKC,GAAG,MAAM,gBAAgB;AAIrC,MAAMC,MAAM,GAAG,eAAe;AAoD9B;;;;;;;AAOA,OAAM,MAAOC,UAAU;EACrBC,YAAYC,KAAkB;IAC5B,IAAI,CAACA,KAAK,GAAGA,KAAK;EACpB;EACA;;;;;EAKSC,IAAI,GAAG,YAAY;EAC5B;;;;;EAKSC,IAAI,GAAW,YAAY;EACpC;;;;;EAKSF,KAAK;EACd;;;;;EAKA,IAAIG,OAAOA,CAAA;IACT,OAAO,IAAI,CAACH,KAAK,CAACI,QAAQ,EAAE;EAC9B;EACA;;;;;EAKAA,QAAQA,CAAA;IACN,OAAO,cAAc,IAAI,CAACD,OAAO,GAAG;EACtC;;AAiEF;;;;;;;;;;;;AAYA,OAAM,SAAUE,OAAOA,CAAA;EACrB,OAAOC,MAAM,CAACC,MAAM,CAAEC,KAAyB,IAAKA,KAAU,EAAE;IAC9DC,MAAM,EAAGD,KAAyB,IAAKd,MAAM,CAACgB,IAAI,CAACF,KAAU,CAAC;IAC9DG,MAAM,EAAGH,KAAyB,IAAKb,MAAM,CAACiB,OAAO,CAACJ,KAAU,CAAC;IACjEK,EAAE,EAAGC,CAAqB,IAAkC;GAC7D,CAAC;AACJ;AAEA;;;;;;;;;;;AAWA,OAAM,SAAUC,IAAIA,CAClBC,MAA8D;EAE9D,OAAOC,KAAK,CAACrB,GAAG,CAACsB,UAAU,CAACF,MAAM,CAAC,CAAC;AACtC;AAEA;;;;;;;;;AASA,OAAM,SAAUC,KAAKA,CACnB,GAAGE,MAGF;EAED,MAAMR,MAAM,GAAIH,KAAyB,IAAkC;IACzE,OAAOb,MAAM,CAACyB,QAAQ,CAACxB,GAAG,CAACyB,SAAS,CAACF,MAAM,EAAEX,KAAK,CAAC,EAAGR,KAAK,IAAK,IAAIF,UAAU,CAACE,KAAK,CAAC,CAAQ;EAC/F,CAAC;EACD,OAAOM,MAAM,CAACC,MAAM,CAAEC,KAAyB,IAAKb,MAAM,CAAC2B,UAAU,CAACX,MAAM,CAACH,KAAK,CAAC,CAAC,EAAE;IACpFC,MAAM,EAAGD,KAAyB,IAAKd,MAAM,CAAC6B,UAAU,CAACZ,MAAM,CAACH,KAAK,CAAC,CAAC;IACvEG,MAAM;IACNE,EAAE,EAAGL,KAAyB,IAAsCb,MAAM,CAAC6B,SAAS,CAACb,MAAM,CAACH,KAAK,CAAC,CAAC;IACnGW;GACD,CAAC;AACJ;AAEA;;;;;;;;AAQA,OAAM,SAAUM,GAAGA,CACjB,GAAGC,MAAsC;EAKzC,MAAMP,MAAM,GAAGO,MAAM,CAACC,OAAO,CAAEC,KAAK,IAAKA,KAAK,CAACT,MAAM,IAAI,EAAE,CAAC;EAC5D,OAAO1B,GAAG,CAACoC,eAAe,CAACV,MAAM,CAAC,GAChCF,KAAK,CAAC,GAAGE,MAAM,CAAC,GAChBd,OAAO,EAAE;AACb","ignoreList":[]}