effect 4.0.0-beta.69 → 4.0.0-beta.70

package/dist/Equivalence.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Equivalence.d.ts","sourceRoot":"","sources":["../src/Equivalence.ts"],"names":[],"mappings":"AAsDA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAC1C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,OAAO,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;CAC3C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,OAAO,KAAG,WAAW,CAAC,CAAC,CACxC,CAAA;AAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,CAA4B,CAAA;AAE5E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,MAAM,EAAE,WAAW,CAAC,MAAM,CAAsB,CAAA;AAE7D;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,EAAE,WAAW,CAAC,MAAM,CAEtC,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,EAAE,WAAW,CAAC,OAAO,CAAsB,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,MAAM,EAAE,WAAW,CAAC,MAAM,CAAsB,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAA;IACnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;CACuD,CAAA;AAExH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,YAAY,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAG,WAAW,CAAC,CAAC,CAQ9E,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAA;IAChE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;CAI7D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,wBAAgB,KAAK,CAAC,KAAK,CAAC,QAAQ,SAAS,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAC1E,QAAQ,EAAE,QAAQ,GACjB,WAAW,CAAC;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,CAY3G;AAED;;GAEG;AACH,iBAAS,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAUtE;AACD,OAAO;AACL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,IAAI,KAAK,EAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,EAC/D,MAAM,EAAE,CAAC,GACR,WAAW,CAAC;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,CAQ7F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAepF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,WAAW,CAAC,CAAC,qCAM5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,eAAO,MAAM,IAAI,EAAE,WAAW,CAAC,IAAI,CAGlC,CAAA"}
+{"version":3,"file":"Equivalence.d.ts","sourceRoot":"","sources":["../src/Equivalence.ts"],"names":[],"mappings":"AAsDA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAC1C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,OAAO,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;CAC3C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,OAAO,KAAG,WAAW,CAAC,CAAC,CACxC,CAAA;AAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,CAA4B,CAAA;AAE5E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,MAAM,EAAE,WAAW,CAAC,MAAM,CAAsB,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM,EAAE,WAAW,CAAC,MAAM,CAEtC,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,EAAE,WAAW,CAAC,OAAO,CAAsB,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,MAAM,EAAE,WAAW,CAAC,MAAM,CAAsB,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAA;IACnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;CACuD,CAAA;AAExH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,YAAY,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAG,WAAW,CAAC,CAAC,CAQ9E,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6DG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAA;IAChE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6DG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;CAI7D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,wBAAgB,KAAK,CAAC,KAAK,CAAC,QAAQ,SAAS,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAC1E,QAAQ,EAAE,QAAQ,GACjB,WAAW,CAAC;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,CAY3G;AAED;;GAEG;AACH,iBAAS,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAUtE;AACD,OAAO;AACL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,IAAI,KAAK,EAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,EAC/D,MAAM,EAAE,CAAC,GACR,WAAW,CAAC;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,CAQ7F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAepF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,WAAW,CAAC,CAAC,qCAM5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,IAAI,EAAE,WAAW,CAAC,IAAI,CAGlC,CAAA"}

package/dist/Equivalence.js

@@ -56,12 +56,14 @@ import * as Reducer from "./Reducer.js";
 /**
  * Creates a custom equivalence relation with an optimized reference equality check.
  *
- * When to use this:
- * - When you need a custom equivalence that isn't just strict equality
- * - When creating equivalences for complex types with custom comparison logic
- * - When you want the performance benefit of reference equality optimization
+ * **When to use**
+ *
+ * - Use when you need a custom equivalence that is not just strict equality
+ * - Use when creating equivalences for complex types with custom comparison logic
+ * - Use when you want the performance benefit of reference equality optimization
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - First checks reference equality (`===`) for performance; if values are identical, returns `true` without calling the function
  * - Falls back to the provided equivalence function if values are not the same reference
@@ -91,12 +93,12 @@ import * as Reducer from "./Reducer.js";
  *
  * const tolerance = Equivalence.make<number>((a, b) => Math.abs(a - b) < 0.0001)
  *
- * console.log(tolerance(1.0, 1.0001)) // false
+ * console.log(tolerance(1.0, 1.001)) // false
  * console.log(tolerance(1.0, 1.00001)) // true
  * ```
  *
- * See also: {@link strictEqual}, {@link mapInput}
- *
+ * @see {@link strictEqual}
+ * @see {@link mapInput}
  * @category constructors
  * @since 2.0.0
  */
@@ -105,18 +107,23 @@ const isStrictEquivalent = (x, y) => x === y;
 /**
  * Creates an equivalence relation that uses strict equality (`===`) to compare values.
  *
- * When to use this:
- * - For primitive types (numbers, strings, booleans) where `===` is appropriate
- * - When you need reference equality for objects (same object instance)
- * - As a building block for more complex equivalences via {@link mapInput} or {@link combine}
- * - When performance is critical and you don't need structural equality
+ * **When to use**
+ *
+ * - Use for primitive types where `===` is appropriate
+ * - Use when you need reference equality for objects
+ * - Use as a building block for more complex equivalences via {@link mapInput} or {@link combine}
+ * - Use when performance is critical and you do not need structural equality
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Uses JavaScript's strict equality operator (`===`)
  * - For primitives: compares values directly
- * - For objects: compares by reference (same object instance)
- * - Note: `NaN !== NaN`, so `NaN` values are never considered equivalent
+ * - For objects: compares by reference, so only the same object instance is equivalent
+ *
+ * **Gotchas**
+ *
+ * `NaN !== NaN`, so `NaN` values are never considered equivalent.
  *
  * **Example** (Primitive types)
  *
@@ -142,8 +149,8 @@ const isStrictEquivalent = (x, y) => x === y;
  * console.log(strictObjEq(obj, { value: 42 })) // false (different references)
  * ```
  *
- * See also: {@link make}, {@link Equal} (for structural equality)
- *
+ * @see {@link make}
+ * @see {@link Equal} for structural equality
  * @category constructors
  * @since 4.0.0
  */
@@ -167,6 +174,8 @@ export const String = isStrictEquivalent;
 /**
  * An `Equivalence` instance for numbers.
  *
+ * **Details**
+ *
  * `NaN` is considered equal to `NaN`.
  *
  * **Example** (Comparing numbers)
@@ -218,16 +227,18 @@ export const BigInt = isStrictEquivalent;
 /**
  * Combines two equivalence relations using logical AND.
  *
- * When to use this:
- * - When you need to combine exactly two equivalences
- * - When building complex equivalences from simpler ones
- * - When you want both conditions to be satisfied (AND logic)
+ * **When to use**
+ *
+ * - Use when you need to combine exactly two equivalences
+ * - Use when building complex equivalences from simpler ones
+ * - Use when you want both conditions to be satisfied
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Returns `true` only if both equivalences return `true`
  * - Short-circuits: if the first equivalence returns `false`, the second is not called
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+ * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
  *
  * **Example** (Combining name and age equivalences)
  *
@@ -259,8 +270,8 @@ export const BigInt = isStrictEquivalent;
  * console.log(personEquivalence(person1, person3)) // false (different age)
  * ```
  *
- * See also: {@link combineAll}, {@link mapInput}
- *
+ * @see {@link combineAll}
+ * @see {@link mapInput}
  * @category combining
  * @since 2.0.0
  */
@@ -268,18 +279,20 @@ export const combine = /*#__PURE__*/dual(2, (self, that) => make((x, y) => self(
 /**
  * Combines multiple equivalence relations into a single equivalence using logical AND.
  *
- * When to use this:
- * - When you need to combine three or more equivalences
- * - When you have a dynamic collection of equivalences to combine
- * - When building equivalences from arrays or iterables
- * - Prefer over multiple `combine` calls when you have many equivalences
+ * **When to use**
+ *
+ * - Use when you need to combine three or more equivalences
+ * - Use when you have a dynamic collection of equivalences to combine
+ * - Use when building equivalences from arrays or iterables
+ * - Prefer this over multiple `combine` calls when you have many equivalences
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Returns `true` only if all equivalences in the collection return `true`
  * - Short-circuits: stops at the first equivalence that returns `false`
- * - Empty collection edge case: returns an equivalence that always returns `true`
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+ * - Empty collections return an equivalence that always returns `true`
+ * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
  *
  * **Example** (Combining multiple field equivalences)
  *
@@ -325,8 +338,8 @@ export const combine = /*#__PURE__*/dual(2, (self, that) => make((x, y) => self(
  * console.log(alwaysEq("anything", "else")) // true
  * ```
  *
- * See also: {@link combine}, {@link mapInput}
- *
+ * @see {@link combine}
+ * @see {@link mapInput}
  * @category combining
  * @since 2.0.0
  */
@@ -341,18 +354,20 @@ export const combineAll = collection => make((x, y) => {
 /**
  * Transforms an equivalence relation by mapping the input values before comparison.
  *
- * When to use this:
- * - When you need an equivalence for a complex type based on a single property
- * - When you want to normalize values before comparison (e.g., case-insensitive strings)
- * - When creating equivalences that focus on specific fields of objects
- * - As a building block for creating equivalences via {@link combine} or {@link combineAll}
+ * **When to use**
+ *
+ * - Use when you need an equivalence for a complex type based on a single property
+ * - Use when you want to normalize values before comparison, such as case-insensitive strings
+ * - Use when creating equivalences that focus on specific fields of objects
+ * - Use as a building block for creating equivalences via {@link combine} or {@link combineAll}
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Applies the transformation function to both values before comparing
- * - The transformation function should be pure (no side effects)
+ * - The transformation function should be pure and have no side effects
  * - The resulting equivalence compares the transformed values using the provided equivalence
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+ * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
  *
  * **Example** (Equivalence based on object property)
  *
@@ -393,8 +408,8 @@ export const combineAll = collection => make((x, y) => {
  * console.log(caseInsensitiveEq("Hello", "World")) // false
  * ```
  *
- * See also: {@link combine}, {@link Struct}
- *
+ * @see {@link combine}
+ * @see {@link Struct}
  * @category mapping
  * @since 2.0.0
  */
@@ -402,18 +417,20 @@ export const mapInput = /*#__PURE__*/dual(2, (self, f) => make((x, y) => self(f(
 /**
  * Creates an equivalence for tuples with heterogeneous element types.
  *
- * When to use this:
- * - When comparing tuples with different types at each position
- * - When you need different equivalence logic for each tuple element
- * - When working with fixed-length tuples (not arrays)
- * - Prefer over `Array` when you have a known tuple structure with different types
+ * **When to use**
+ *
+ * - Use when comparing tuples with different types at each position
+ * - Use when you need different equivalence logic for each tuple element
+ * - Use when working with fixed-length tuples instead of arrays
+ * - Prefer this over `Array` when you have a known tuple structure with different types
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Requires tuples to have the same length; different lengths are never equivalent
  * - Applies each equivalence to the corresponding element position
  * - Returns `true` only if all elements are equivalent according to their respective equivalences
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+ * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
  *
  * **Example** (Homogeneous tuple equivalence)
  *
@@ -434,7 +451,7 @@ export const mapInput = /*#__PURE__*/dual(2, (self, f) => make((x, y) => self(f(
  * console.log(stringTupleEq(tuple1, tuple3)) // false (different third element)
  * ```
  *
- * **Example** (Heterogeneous tuple with custom equivalences)
+ * **Example** (Tuple with custom equivalences)
  *
  * ```ts
  * import { Equivalence } from "effect"
@@ -455,8 +472,8 @@ export const mapInput = /*#__PURE__*/dual(2, (self, f) => make((x, y) => self(f(
  * ) // true
  * ```
  *
- * See also: {@link Array_}, {@link Struct}
- *
+ * @see {@link Array_}
+ * @see {@link Struct}
  * @category combinators
  * @since 4.0.0
  */
@@ -489,19 +506,21 @@ export {
 /**
  * Creates an equivalence for arrays where all elements are compared using the same equivalence.
  *
- * When to use this:
- * - When comparing arrays with homogeneous element types
- * - When all elements should use the same equivalence logic
- * - When working with variable-length arrays (not fixed tuples)
- * - Prefer over `Tuple` when you have arrays of the same type
+ * **When to use**
+ *
+ * - Use when comparing arrays with homogeneous element types
+ * - Use when all elements should use the same equivalence logic
+ * - Use when working with variable-length arrays instead of fixed tuples
+ * - Prefer this over `Tuple` when you have arrays of the same type
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Requires arrays to have the same length; different lengths are never equivalent
- * - Compares elements positionally (index 0 with index 0, etc.)
+ * - Compares elements positionally, such as index `0` with index `0`
  * - Returns `true` only if all corresponding elements are equivalent
  * - Empty arrays are considered equivalent
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+ * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
  *
  * **Example** (Number array equivalence)
  *
@@ -531,8 +550,8 @@ export {
  * console.log(stringArrayEq([], [])) // true (empty arrays)
  * ```
  *
- * See also: {@link Tuple}, {@link Record}
- *
+ * @see {@link Tuple}
+ * @see {@link Record}
  * @category combinators
  * @since 4.0.0
  */
@@ -540,19 +559,21 @@ Array_ as Array };
 /**
  * Creates an equivalence for objects by comparing their properties using provided equivalences.
  *
- * When to use this:
- * - When comparing objects with known, fixed property names
- * - When you need different equivalence logic for different properties
- * - When working with struct/interface types with specific fields
- * - Prefer over `Record` when you have a fixed set of known properties
+ * **When to use**
+ *
+ * - Use when comparing objects with known, fixed property names
+ * - Use when you need different equivalence logic for different properties
+ * - Use when working with struct or interface types with specific fields
+ * - Prefer this over `Record` when you have a fixed set of known properties
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Compares only the properties specified in the struct definition
  * - Properties not in the struct are ignored
  * - Returns `true` only if all specified properties are equivalent according to their equivalences
- * - Supports both string and symbol keys (via `Reflect.ownKeys`)
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+ * - Supports both string and symbol keys via `Reflect.ownKeys`
+ * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
  *
  * **Example** (Struct with different equivalences per field)
  *
@@ -600,8 +621,9 @@ Array_ as Array };
  * console.log(nameAgeEq(obj1, obj2)) // true
  * ```
  *
- * See also: {@link Record}, {@link mapInput}, {@link combine}
- *
+ * @see {@link Record}
+ * @see {@link mapInput}
+ * @see {@link combine}
  * @category combinators
  * @since 4.0.0
  */
@@ -617,20 +639,22 @@ export function Struct(fields) {
 /**
  * Creates an equivalence for objects by comparing all properties using the same equivalence.
  *
- * When to use this:
- * - When comparing objects with dynamic or unknown property names
- * - When all property values should use the same equivalence logic
- * - When working with record/dictionary types (key-value maps)
- * - Prefer over `Struct` when you have variable properties or need to compare all properties uniformly
+ * **When to use**
+ *
+ * - Use when comparing objects with dynamic or unknown property names
+ * - Use when all property values should use the same equivalence logic
+ * - Use when working with record or dictionary types
+ * - Prefer this over `Struct` when you have variable properties or need to compare all properties uniformly
+ *
+ * **Details**
  *
- * Behavior:
  * - Does not mutate inputs
  * - Compares all properties present in both objects
  * - Requires both objects to have the same set of keys; different keys result in `false`
  * - All property values must be equivalent according to the provided equivalence
- * - Supports both string and symbol keys (via `Reflect.ownKeys`)
+ * - Supports both string and symbol keys via `Reflect.ownKeys`
  * - Empty objects are considered equivalent
- * - The result is also an equivalence (satisfies reflexive, symmetric, transitive properties)
+ * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
  *
  * **Example** (Record with string values)
  *
@@ -664,8 +688,8 @@ export function Struct(fields) {
  * console.log(numberRecordEq(scores1, scores3)) // false
  * ```
  *
- * See also: {@link Struct}, {@link Array_}
- *
+ * @see {@link Struct}
+ * @see {@link Array_}
  * @category combinators
  * @since 4.0.0
  */
@@ -685,14 +709,16 @@ export function Record(value) {
 /**
  * Creates a `Reducer` for combining `Equivalence` instances, useful for aggregating equivalences in collections.
  *
- * When to use this:
- * - When you need to combine multiple equivalences from a collection using reducer patterns
- * - When implementing fold operations over collections of equivalences
- * - When working with reducers that operate on equivalences
+ * **When to use**
+ *
+ * - Use when you need to combine multiple equivalences from a collection using reducer patterns
+ * - Use when implementing fold operations over collections of equivalences
+ * - Use when working with reducers that operate on equivalences
+ *
+ * **Details**
  *
- * Behavior:
  * - Returns a reducer that combines equivalences using {@link combine}
- * - Uses an equivalence that always returns `true` as the identity element (for empty collections)
+ * - Uses an equivalence that always returns `true` as the identity element for empty collections
  * - Uses {@link combineAll} for combining collections of equivalences
  * - The reducer can be used with fold operations on collections
  *
@@ -713,11 +739,9 @@ export function Record(value) {
  * console.log(combined(1, 1.5)) // false (strict equal fails)
  * ```
  *
- * See also:
- * - {@link combine} - Combine two equivalences
- * - {@link combineAll} - Combine multiple equivalences
- * - {@link Reducer} - Reducer type for collection operations
- *
+ * @see {@link combine} Combine two equivalences
+ * @see {@link combineAll} Combine multiple equivalences
+ * @see {@link Reducer} Reducer type for collection operations
  * @category utils
  * @since 4.0.0
  */
@@ -725,12 +749,12 @@ export function makeReducer() {
   return Reducer.make(combine, () => true, combineAll);
 }
 /**
- * An `Equivalence` instance for `Date` objects that compares their
- * `getTime()` values using `Equivalence.Number`.
+ * An `Equivalence` instance for `Date` objects that compares their `getTime()` values using `Equivalence.Number`.
  *
- * Different `Date` instances that represent the same millisecond timestamp are
- * equivalent. Because `Equivalence.Number` treats `NaN` as equal to `NaN`, two
- * invalid `Date` values are also considered equivalent.
+ * **Details**
+ *
+ * Different `Date` instances that represent the same millisecond timestamp are equivalent. Because `Equivalence.Number`
+ * treats `NaN` as equal to `NaN`, two invalid `Date` values are also considered equivalent.
  *
  * **Example** (Comparing Date values)
  *
@@ -761,8 +785,9 @@ export function makeReducer() {
  * console.log(Equivalence.Date(d1, d2)) // true (same time value)
  * ```
  *
- * See also: {@link Number}, {@link mapInput}, {@link strictEqual}
- *
+ * @see {@link Number}
+ * @see {@link mapInput}
+ * @see {@link strictEqual}
  * @category instances
  * @since 2.0.0
  */

package/dist/Equivalence.js.map

@@ -1 +1 @@
-{"version":3,"file":"Equivalence.js","names":["dual","Reducer","make","isEquivalent","self","that","isStrictEquivalent","x","y","strictEqual","String","Number","globalThis","isNaN","Boolean","BigInt","combine","combineAll","collection","equivalence","mapInput","f","Tuple","elements","length","i","Array_","item","Array","Struct","fields","keys","Reflect","ownKeys","key","Record","value","selfKeys","thatKeys","Object","hasOwn","makeReducer","Date","d","getTime"],"sources":["../src/Equivalence.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqDA,SAASA,IAAI,QAAQ,eAAe;AAEpC,OAAO,KAAKC,OAAO,MAAM,cAAc;AAsFvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CA,OAAO,MAAMC,IAAI,GAAOC,YAA2C,IAAqB,CAACC,IAAO,EAAEC,IAAO,KACvGD,IAAI,KAAKC,IAAI,IAAIF,YAAY,CAACC,IAAI,EAAEC,IAAI,CAAC;AAE3C,MAAMC,kBAAkB,GAAGA,CAACC,CAAU,EAAEC,CAAU,KAAKD,CAAC,KAAKC,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,OAAO,MAAMC,WAAW,GAA4BA,CAAA,KAAMH,kBAAkB;AAE5E;;;;;;;;;;;;;;;AAeA,OAAO,MAAMI,MAAM,GAAwBJ,kBAAkB;AAE7D;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMK,MAAM,gBAAwBT,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KACzDO,UAAU,CAACD,MAAM,CAACE,KAAK,CAACT,IAAI,CAAC,IAAIQ,UAAU,CAACD,MAAM,CAACE,KAAK,CAACR,IAAI,CAAC,CAC/D;AAED;;;;;;;;;;;;;;;AAeA,OAAO,MAAMS,OAAO,GAAyBR,kBAAkB;AAE/D;;;;;;;;;;;;;;;AAeA,OAAO,MAAMS,MAAM,GAAwBT,kBAAkB;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiDA,OAAO,MAAMU,OAAO,gBAqGhBhB,IAAI,CAAC,CAAC,EAAE,CAAII,IAAoB,EAAEC,IAAoB,KAAqBH,IAAI,CAAC,CAACK,CAAC,EAAEC,CAAC,KAAKJ,IAAI,CAACG,CAAC,EAAEC,CAAC,CAAC,IAAIH,IAAI,CAACE,CAAC,EAAEC,CAAC,CAAC,CAAC,CAAC;AAExH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiEA,OAAO,MAAMS,UAAU,GAAOC,UAAoC,IAChEhB,IAAI,CAAC,CAACK,CAAC,EAAEC,CAAC,KAAI;EACZ,KAAK,MAAMW,WAAW,IAAID,UAAU,EAAE;IACpC,IAAI,CAACC,WAAW,CAACZ,CAAC,EAAEC,CAAC,CAAC,EAAE;MACtB,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,OAAO,MAAMY,QAAQ,gBA2HjBpB,IAAI,CACN,CAAC,EACD,CAAOI,IAAoB,EAAEiB,CAAc,KAAqBnB,IAAI,CAAC,CAACK,CAAC,EAAEC,CAAC,KAAKJ,IAAI,CAACiB,CAAC,CAACd,CAAC,CAAC,EAAEc,CAAC,CAACb,CAAC,CAAC,CAAC,CAAC,CACjG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6DA,OAAM,SAAUc,KAAKA,CACnBC,QAAkB;EAElB,OAAOrB,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,IAAID,IAAI,CAACoB,MAAM,KAAKnB,IAAI,CAACmB,MAAM,EAAE;MAC/B,OAAO,KAAK;IACd;IACA,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGrB,IAAI,CAACoB,MAAM,EAAEC,CAAC,EAAE,EAAE;MACpC,IAAI,CAACF,QAAQ,CAACE,CAAC,CAAC,CAACrB,IAAI,CAACqB,CAAC,CAAC,EAAEpB,IAAI,CAACoB,CAAC,CAAC,CAAC,EAAE;QAClC,OAAO,KAAK;MACd;IACF;IACA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AAEA;;;AAGA,SAASC,MAAMA,CAAIC,IAAoB;EACrC,OAAOzB,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,IAAID,IAAI,CAACoB,MAAM,KAAKnB,IAAI,CAACmB,MAAM,EAAE,OAAO,KAAK;IAE7C,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGrB,IAAI,CAACoB,MAAM,EAAEC,CAAC,EAAE,EAAE;MACpC,IAAI,CAACE,IAAI,CAACvB,IAAI,CAACqB,CAAC,CAAC,EAAEpB,IAAI,CAACoB,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK;IAC3C;IAEA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AACA;AACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDAC,MAAM,IAAIE,KAAK;AAGjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,OAAM,SAAUC,MAAMA,CACpBC,MAAS;EAET,MAAMC,IAAI,GAAeC,OAAO,CAACC,OAAO,CAACH,MAAM,CAAC;EAChD,OAAO5B,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,KAAK,MAAM6B,GAAG,IAAIH,IAAI,EAAE;MACtB,IAAI,CAACD,MAAM,CAACI,GAAG,CAAC,CAAC9B,IAAI,CAAC8B,GAAG,CAAC,EAAE7B,IAAI,CAAC6B,GAAG,CAAC,CAAC,EAAE,OAAO,KAAK;IACtD;IACA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuDA,OAAM,SAAUC,MAAMA,CAAIC,KAAqB;EAC7C,OAAOlC,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,MAAMgC,QAAQ,GAAGL,OAAO,CAACC,OAAO,CAAC7B,IAAI,CAAC;IACtC,MAAMkC,QAAQ,GAAGN,OAAO,CAACC,OAAO,CAAC5B,IAAI,CAAC;IAEtC,IAAIgC,QAAQ,CAACb,MAAM,KAAKc,QAAQ,CAACd,MAAM,EAAE,OAAO,KAAK;IAErD,KAAK,MAAMU,GAAG,IAAIG,QAAQ,EAAE;MAC1B,IAAI,CAACE,MAAM,CAACC,MAAM,CAACnC,IAAI,EAAE6B,GAAG,CAAC,IAAI,CAACE,KAAK,CAAChC,IAAI,CAAC8B,GAAG,CAAC,EAAE7B,IAAI,CAAC6B,GAAG,CAAC,CAAC,EAAE;QAC7D,OAAO,KAAK;MACd;IACF;IAEA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,OAAM,SAAUO,WAAWA,CAAA;EACzB,OAAOxC,OAAO,CAACC,IAAI,CACjBc,OAAO,EACP,MAAM,IAAI,EACVC,UAAU,CACX;AACH;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,OAAO,MAAMyB,IAAI,gBAAsBtB,QAAQ,CAC7CT,MAAM,EACLgC,CAAO,IAAKA,CAAC,CAACC,OAAO,EAAE,CACzB","ignoreList":[]}
+{"version":3,"file":"Equivalence.js","names":["dual","Reducer","make","isEquivalent","self","that","isStrictEquivalent","x","y","strictEqual","String","Number","globalThis","isNaN","Boolean","BigInt","combine","combineAll","collection","equivalence","mapInput","f","Tuple","elements","length","i","Array_","item","Array","Struct","fields","keys","Reflect","ownKeys","key","Record","value","selfKeys","thatKeys","Object","hasOwn","makeReducer","Date","d","getTime"],"sources":["../src/Equivalence.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqDA,SAASA,IAAI,QAAQ,eAAe;AAEpC,OAAO,KAAKC,OAAO,MAAM,cAAc;AA0FvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiDA,OAAO,MAAMC,IAAI,GAAOC,YAA2C,IAAqB,CAACC,IAAO,EAAEC,IAAO,KACvGD,IAAI,KAAKC,IAAI,IAAIF,YAAY,CAACC,IAAI,EAAEC,IAAI,CAAC;AAE3C,MAAMC,kBAAkB,GAAGA,CAACC,CAAU,EAAEC,CAAU,KAAKD,CAAC,KAAKC,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDA,OAAO,MAAMC,WAAW,GAA4BA,CAAA,KAAMH,kBAAkB;AAE5E;;;;;;;;;;;;;;;AAeA,OAAO,MAAMI,MAAM,GAAwBJ,kBAAkB;AAE7D;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMK,MAAM,gBAAwBT,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KACzDO,UAAU,CAACD,MAAM,CAACE,KAAK,CAACT,IAAI,CAAC,IAAIQ,UAAU,CAACD,MAAM,CAACE,KAAK,CAACR,IAAI,CAAC,CAC/D;AAED;;;;;;;;;;;;;;;AAeA,OAAO,MAAMS,OAAO,GAAyBR,kBAAkB;AAE/D;;;;;;;;;;;;;;;AAeA,OAAO,MAAMS,MAAM,GAAwBT,kBAAkB;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDA,OAAO,MAAMU,OAAO,gBAyGhBhB,IAAI,CAAC,CAAC,EAAE,CAAII,IAAoB,EAAEC,IAAoB,KAAqBH,IAAI,CAAC,CAACK,CAAC,EAAEC,CAAC,KAAKJ,IAAI,CAACG,CAAC,EAAEC,CAAC,CAAC,IAAIH,IAAI,CAACE,CAAC,EAAEC,CAAC,CAAC,CAAC,CAAC;AAExH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,OAAO,MAAMS,UAAU,GAAOC,UAAoC,IAChEhB,IAAI,CAAC,CAACK,CAAC,EAAEC,CAAC,KAAI;EACZ,KAAK,MAAMW,WAAW,IAAID,UAAU,EAAE;IACpC,IAAI,CAACC,WAAW,CAACZ,CAAC,EAAEC,CAAC,CAAC,EAAE;MACtB,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,OAAO,MAAMY,QAAQ,gBA+HjBpB,IAAI,CACN,CAAC,EACD,CAAOI,IAAoB,EAAEiB,CAAc,KAAqBnB,IAAI,CAAC,CAACK,CAAC,EAAEC,CAAC,KAAKJ,IAAI,CAACiB,CAAC,CAACd,CAAC,CAAC,EAAEc,CAAC,CAACb,CAAC,CAAC,CAAC,CAAC,CACjG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DA,OAAM,SAAUc,KAAKA,CACnBC,QAAkB;EAElB,OAAOrB,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,IAAID,IAAI,CAACoB,MAAM,KAAKnB,IAAI,CAACmB,MAAM,EAAE;MAC/B,OAAO,KAAK;IACd;IACA,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGrB,IAAI,CAACoB,MAAM,EAAEC,CAAC,EAAE,EAAE;MACpC,IAAI,CAACF,QAAQ,CAACE,CAAC,CAAC,CAACrB,IAAI,CAACqB,CAAC,CAAC,EAAEpB,IAAI,CAACoB,CAAC,CAAC,CAAC,EAAE;QAClC,OAAO,KAAK;MACd;IACF;IACA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AAEA;;;AAGA,SAASC,MAAMA,CAAIC,IAAoB;EACrC,OAAOzB,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,IAAID,IAAI,CAACoB,MAAM,KAAKnB,IAAI,CAACmB,MAAM,EAAE,OAAO,KAAK;IAE7C,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGrB,IAAI,CAACoB,MAAM,EAAEC,CAAC,EAAE,EAAE;MACpC,IAAI,CAACE,IAAI,CAACvB,IAAI,CAACqB,CAAC,CAAC,EAAEpB,IAAI,CAACoB,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK;IAC3C;IAEA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AACA;AACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDAC,MAAM,IAAIE,KAAK;AAGjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,OAAM,SAAUC,MAAMA,CACpBC,MAAS;EAET,MAAMC,IAAI,GAAeC,OAAO,CAACC,OAAO,CAACH,MAAM,CAAC;EAChD,OAAO5B,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,KAAK,MAAM6B,GAAG,IAAIH,IAAI,EAAE;MACtB,IAAI,CAACD,MAAM,CAACI,GAAG,CAAC,CAAC9B,IAAI,CAAC8B,GAAG,CAAC,EAAE7B,IAAI,CAAC6B,GAAG,CAAC,CAAC,EAAE,OAAO,KAAK;IACtD;IACA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDA,OAAM,SAAUC,MAAMA,CAAIC,KAAqB;EAC7C,OAAOlC,IAAI,CAAC,CAACE,IAAI,EAAEC,IAAI,KAAI;IACzB,MAAMgC,QAAQ,GAAGL,OAAO,CAACC,OAAO,CAAC7B,IAAI,CAAC;IACtC,MAAMkC,QAAQ,GAAGN,OAAO,CAACC,OAAO,CAAC5B,IAAI,CAAC;IAEtC,IAAIgC,QAAQ,CAACb,MAAM,KAAKc,QAAQ,CAACd,MAAM,EAAE,OAAO,KAAK;IAErD,KAAK,MAAMU,GAAG,IAAIG,QAAQ,EAAE;MAC1B,IAAI,CAACE,MAAM,CAACC,MAAM,CAACnC,IAAI,EAAE6B,GAAG,CAAC,IAAI,CAACE,KAAK,CAAChC,IAAI,CAAC8B,GAAG,CAAC,EAAE7B,IAAI,CAAC6B,GAAG,CAAC,CAAC,EAAE;QAC7D,OAAO,KAAK;MACd;IACF;IAEA,OAAO,IAAI;EACb,CAAC,CAAC;AACJ;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,OAAM,SAAUO,WAAWA,CAAA;EACzB,OAAOxC,OAAO,CAACC,IAAI,CACjBc,OAAO,EACP,MAAM,IAAI,EACVC,UAAU,CACX;AACH;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,OAAO,MAAMyB,IAAI,gBAAsBtB,QAAQ,CAC7CT,MAAM,EACLgC,CAAO,IAAKA,CAAC,CAACC,OAAO,EAAE,CACzB","ignoreList":[]}

package/dist/ErrorReporter.d.ts

@@ -74,11 +74,13 @@ export type TypeId = "~effect/ErrorReporter";
 export declare const TypeId: TypeId;
 /**
  * An `ErrorReporter` receives reported failures and forwards them to an
- * external system (logging service, error tracker, etc.).
+ * external system such as a logging service or error tracker.
+ *
+ * **Details**
  *
  * Reporting is triggered by `Effect.withErrorReporting`,
  * `ErrorReporter.report`, or built-in boundaries in the HTTP and RPC server
- * modules. Use {@link make} to create a reporter — it handles deduplication
+ * modules. Use {@link make} to create a reporter; it handles deduplication
  * and per-error annotation extraction automatically.
  *
  * @category models
@@ -95,6 +97,8 @@ export interface ErrorReporter {
 /**
  * Creates an `ErrorReporter` from a callback.
  *
+ * **Details**
+ *
  * The returned reporter automatically deduplicates causes and individual
  * errors (the same object is never reported twice), skips interruptions,
  * and resolves the `ignore`, `severity`, and `attributes` annotations on
@@ -128,6 +132,8 @@ export declare const make: (report: (options: {
  * A `Context.Reference` holding the set of active `ErrorReporter`s for the
  * current fiber. Defaults to an empty set (no reporting).
  *
+ * **When to use**
+ *
  * Prefer {@link layer} to configure reporters via the `Layer` API. Use this
  * reference directly only when you need low-level control (e.g. reading the
  * current reporters or swapping them inside a `FiberRef`).
@@ -139,12 +145,12 @@ export declare const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorR
 /**
  * Creates a `Layer` that registers one or more `ErrorReporter`s.
  *
- * Reporters can be plain `ErrorReporter` values or effectful
- * `Effect<ErrorReporter>` values that are resolved when the layer is built.
+ * **Details**
  *
- * By default the provided reporters **replace** any previously registered
- * reporters. Set `mergeWithExisting: true` to add them alongside existing
- * ones.
+ * Reporters can be plain `ErrorReporter` values or effectful
+ * `Effect<ErrorReporter>` values that are resolved when the layer is built. By
+ * default the provided reporters **replace** any previously registered
+ * reporters. Set `mergeWithExisting: true` to add them alongside existing ones.
  *
  * **Example** (Providing error reporters)
  *
@@ -184,9 +190,11 @@ export declare const layer: <const Reporters extends ReadonlyArray<ErrorReporter
     readonly mergeWithExisting?: boolean | undefined;
 } | undefined) => Layer.Layer<never, Reporters extends readonly [] ? never : Effect.Error<Reporters[number]>, Exclude<Reporters extends readonly [] ? never : Effect.Services<Reporters[number]>, Scope.Scope>>;
 /**
- * Manually report a `Cause` to all registered `ErrorReporter`s on the
+ * Manually reports a `Cause` to all registered `ErrorReporter`s on the
  * current fiber.
  *
+ * **When to use**
+ *
  * This is useful when you want to report an error for observability without
  * actually failing the fiber.
  *
@@ -210,13 +218,14 @@ export declare const report: <E>(cause: Cause.Cause<E>) => Effect.Effect<void>;
 /**
  * Interface that object errors can implement to control reporting behavior.
  *
- * All three annotation properties are optional:
- * - `[ErrorReporter.ignore]` - when `true`, the error is not reported
- * - `[ErrorReporter.severity]` - overrides the default `"Info"` severity
- * - `[ErrorReporter.attributes]` - extra key/value pairs forwarded to reporters
+ * **Details**
  *
- * The global `Error` interface is augmented with `Reportable`, so these
- * properties are available on `Error` instances at the type level.
+ * All three annotation properties are optional: `[ErrorReporter.ignore]`
+ * prevents reporting when set to `true`, `[ErrorReporter.severity]` overrides
+ * the default `"Info"` severity, and `[ErrorReporter.attributes]` adds extra
+ * key/value pairs forwarded to reporters. The global `Error` interface is
+ * augmented with `Reportable`, so these properties are available on `Error`
+ * instances at the type level.
  *
  * @category annotations
  * @since 4.0.0
@@ -234,6 +243,8 @@ declare global {
  * String property key used to mark an object error as ignored by error
  * reporting.
  *
+ * **Details**
+ *
  * Set this property to `true` on an error class or object error to prevent it
  * from being forwarded to reporters. This is useful for expected failures such
  * as HTTP 404 responses.
@@ -246,6 +257,8 @@ export type ignore = "~effect/ErrorReporter/ignore";
  * Runtime property key used to mark an object error as ignored by error
  * reporting.
  *
+ * **Details**
+ *
  * Set `error[ErrorReporter.ignore]` to `true` to prevent the error from being
  * forwarded to reporters. This is useful for expected failures such as HTTP 404
  * responses.
@@ -275,6 +288,8 @@ export declare const isIgnored: (u: unknown) => boolean;
 /**
  * String property key used to override the severity level of an object error.
  *
+ * **Details**
+ *
  * When set to a valid `LogLevel.Severity`, the reporter callback receives this
  * value as `severity`. Missing or invalid values fall back to `"Info"`.
  *
@@ -285,6 +300,8 @@ export type severity = "~effect/ErrorReporter/severity";
 /**
  * Runtime property key used to override the severity level of an object error.
  *
+ * **Details**
+ *
  * Set `error[ErrorReporter.severity]` to a valid `LogLevel.Severity` value.
  * Missing or invalid values fall back to `"Info"`.
  *
@@ -314,6 +331,8 @@ export declare const getSeverity: (error: object) => Severity;
  * String property key used to attach extra key/value metadata to an object
  * error report.
  *
+ * **Details**
+ *
  * Reporters receive these attributes alongside the error, making it easy to
  * include contextual information such as user IDs, request IDs, or other
  * domain-specific debugging data.
@@ -326,6 +345,8 @@ export type attributes = "~effect/ErrorReporter/attributes";
  * Runtime property key used to attach extra key/value metadata to an object
  * error report.
  *
+ * **Details**
+ *
  * Set `error[ErrorReporter.attributes]` to a record of metadata that should be
  * forwarded to reporters alongside the error.
  *

package/dist/ErrorReporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ErrorReporter.d.ts","sourceRoot":"","sources":["../src/ErrorReporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAGxC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,GAAG,uBAAuB,CAAA;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAAgC,CAAA;AAErD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,MAAM,CAAC,OAAO,EAAE;QACd,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAC3B,GAAG,IAAI,CAAA;CACT;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,IAAI,GACf,QAAQ,CAAC,OAAO,EAAE;IAChB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B,KAAK,IAAI,KACT,aA2BF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,EAAE,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAoC,CAAA;AAEpH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,eAAO,MAAM,KAAK,GAChB,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAE7F,WAAW,SAAS,EACpB,UAAU;IAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KACzE,KAAK,CAAC,KAAK,CACZ,KAAK,EACL,SAAS,SAAS,SAAS,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EACvE,OAAO,CACL,SAAS,SAAS,SAAS,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAC1E,KAAK,CAAC,KAAK,CACZ,CAaA,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAIhE,CAAA;AAEJ;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAA;IAC3B,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAA;IAC9B,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAM,SAAQ,UAAU;KAAG;CACtC;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,MAAM,GAAG,8BAA8B,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,MAAM,EAAE,MAAuC,CAAA;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,OAAO,KAAG,OACmC,CAAA;AAE1E;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,GAAG,gCAAgC,CAAA;AAEvD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,EAAE,QAA2C,CAAA;AAElE;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,QAK3C,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,UAAU,GAAG,kCAAkC,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,UAAU,EAAE,UAA+C,CAAA;AAExE;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAE3E,CAAA"}
+{"version":3,"file":"ErrorReporter.d.ts","sourceRoot":"","sources":["../src/ErrorReporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAGxC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,GAAG,uBAAuB,CAAA;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAAgC,CAAA;AAErD;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,MAAM,CAAC,OAAO,EAAE;QACd,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAC3B,GAAG,IAAI,CAAA;CACT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,IAAI,GACf,QAAQ,CAAC,OAAO,EAAE;IAChB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B,KAAK,IAAI,KACT,aA2BF,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,EAAE,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAoC,CAAA;AAEpH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,eAAO,MAAM,KAAK,GAChB,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAE7F,WAAW,SAAS,EACpB,UAAU;IAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KACzE,KAAK,CAAC,KAAK,CACZ,KAAK,EACL,SAAS,SAAS,SAAS,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EACvE,OAAO,CACL,SAAS,SAAS,SAAS,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAC1E,KAAK,CAAC,KAAK,CACZ,CAaA,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAIhE,CAAA;AAEJ;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAA;IAC3B,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAA;IAC9B,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAM,SAAQ,UAAU;KAAG;CACtC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,MAAM,GAAG,8BAA8B,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,MAAM,EAAE,MAAuC,CAAA;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,OAAO,KAAG,OACmC,CAAA;AAE1E;;;;;;;;;;GAUG;AACH,MAAM,MAAM,QAAQ,GAAG,gCAAgC,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,QAAQ,EAAE,QAA2C,CAAA;AAElE;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,QAK3C,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,UAAU,GAAG,kCAAkC,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,UAAU,EAAE,UAA+C,CAAA;AAExE;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAE3E,CAAA"}