effect 4.0.0-beta.2 → 4.0.0-beta.21

package/dist/Equal.js

@@ -2,7 +2,39 @@ import * as Hash from "./Hash.js";
 import { byReferenceInstances, getAllObjectKeys } from "./internal/equal.js";
 import { hasProperty } from "./Predicate.js";
 /**
- * The unique identifier used to identify objects that implement the `Equal` interface.
+ * The unique string identifier for the {@link Equal} interface.
+ *
+ * Use this as a computed property key when implementing custom equality on a
+ * class or object literal.
+ *
+ * When to use:
+ * - As the method name when implementing the {@link Equal} interface.
+ * - To check manually whether an object carries an equality method (prefer
+ *   {@link isEqual} instead).
+ *
+ * Behavior:
+ * - Pure constant — no allocation or side effects.
+ *
+ * **Example** (implementing Equal on a class)
+ *
+ * ```ts
+ * import { Equal, Hash } from "effect"
+ *
+ * class UserId implements Equal.Equal {
+ *   constructor(readonly id: string) {}
+ *
+ *   [Equal.symbol](that: Equal.Equal): boolean {
+ *     return that instanceof UserId && this.id === that.id
+ *   }
+ *
+ *   [Hash.symbol](): number {
+ *     return Hash.string(this.id)
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link Equal} — the interface that uses this symbol
+ * @see {@link isEqual} — type guard for `Equal` implementors
  *
  * @since 2.0.0
  */
@@ -175,37 +207,61 @@ export function makeCompareSet(equivalence) {
 }
 const compareSets = /*#__PURE__*/makeCompareSet(compareBoth);
 /**
- * Determines if a value implements the `Equal` interface.
+ * Checks whether a value implements the {@link Equal} interface.
+ *
+ * When to use:
+ * - To branch on whether a value supports custom equality before calling
+ *   its `[Equal.symbol]` method directly.
+ * - In generic utility code that needs to distinguish `Equal` implementors
+ *   from plain values.
+ *
+ * Behavior:
+ * - Pure function, no side effects.
+ * - Returns `true` if and only if `u` has a property keyed by
+ *   {@link symbol}.
+ * - Acts as a TypeScript type guard, narrowing the input to {@link Equal}.
+ *
+ * **Example** (type guard)
  *
- * @example
  * ```ts
  * import { Equal, Hash } from "effect"
- * import * as assert from "node:assert"
  *
- * class MyClass implements Equal.Equal {
+ * class Token implements Equal.Equal {
+ *   constructor(readonly value: string) {}
  *   [Equal.symbol](that: Equal.Equal): boolean {
- *     return that instanceof MyClass
+ *     return that instanceof Token && this.value === that.value
  *   }
  *   [Hash.symbol](): number {
- *     return 0
+ *     return Hash.string(this.value)
  *   }
  * }
  *
- * const instance = new MyClass()
- * assert(Equal.isEqual(instance) === true)
- * assert(Equal.isEqual({}) === false)
- * assert(Equal.isEqual(42) === false)
+ * console.log(Equal.isEqual(new Token("abc"))) // true
+ * console.log(Equal.isEqual({ x: 1 }))         // false
+ * console.log(Equal.isEqual(42))                // false
  * ```
  *
+ * @see {@link Equal} — the interface being checked
+ * @see {@link symbol} — the property key that signals `Equal` support
+ *
  * @category guards
  * @since 2.0.0
  */
 export const isEqual = u => hasProperty(u, symbol);
 /**
- * Creates an `Equivalence` instance using the `equals` function.
- * This allows the equality logic to be used with APIs that expect an `Equivalence`.
+ * Wraps {@link equals} as an `Equivalence<A>`.
+ *
+ * When to use:
+ * - When an API (e.g. `Array.dedupeWith`, `Equivalence.mapInput`) requires an
+ *   `Equivalence` and you want to reuse `Equal.equals`.
+ *
+ * Behavior:
+ * - Returns a function `(a: A, b: A) => boolean` that delegates to
+ *   {@link equals}.
+ * - Pure; allocates a thin wrapper on each call.
+ *
+ * **Example** (deduplicating with Equal semantics)
  *
- * @example
  * ```ts
  * import { Array, Equal } from "effect"
  *
@@ -214,70 +270,90 @@ export const isEqual = u => hasProperty(u, symbol);
  * console.log(result) // [1, 2, 3]
  * ```
  *
+ * @see {@link equals} — the underlying comparison function
+ *
  * @category instances
  * @since 2.0.0
  */
 export const asEquivalence = () => equals;
 /**
- * Creates a proxy of an object that uses reference equality instead of structural equality.
+ * Creates a proxy that uses reference equality instead of structural equality.
  *
- * By default, plain objects and arrays use structural equality. This function creates
- * a proxy that behaves exactly like the original object but uses reference equality
- * for comparison purposes.
+ * When to use:
+ * - When you have a plain object or array that should be compared by identity
+ *   (reference), not by contents.
+ * - When you want to preserve the original object unchanged and get a new
+ *   reference-equal handle.
  *
- * @example
- * ```ts
- * import { Equal } from "effect"
- * import * as assert from "node:assert"
+ * Behavior:
+ * - Returns a `Proxy` wrapping `obj`. The proxy reads through to the
+ *   original, so property access is unchanged.
+ * - The proxy is registered in an internal WeakSet; {@link equals} returns
+ *   `false` for any pair where at least one operand is in that set (unless
+ *   they are the same reference).
+ * - Each call creates a **new** proxy, so `byReference(x) !== byReference(x)`.
+ * - Does **not** mutate the original object (unlike {@link byReferenceUnsafe}).
  *
- * const obj1 = { a: 1, b: 2 }
- * const obj2 = { a: 1, b: 2 }
+ * **Example** (opting out of structural equality)
  *
- * // Normal structural equality
- * assert(Equal.equals(obj1, obj2) === true)
+ * ```ts
+ * import { Equal } from "effect"
  *
- * // Create reference equality version
- * const obj1ByRef = Equal.byReference(obj1)
- * assert(Equal.equals(obj1ByRef, obj2) === false) // uses reference equality
- * assert(Equal.equals(obj1ByRef, obj1ByRef) === true) // same reference
+ * const a = { x: 1 }
+ * const b = { x: 1 }
  *
- * // Each call creates a new proxy instance
- * const obj1ByRef2 = Equal.byReference(obj1)
- * assert(Equal.equals(obj1ByRef, obj1ByRef2) === false) // different instances
+ * console.log(Equal.equals(a, b)) // true  (structural)
  *
- * // Proxy behaves like the original
- * assert(obj1ByRef.a === 1)
+ * const aRef = Equal.byReference(a)
+ * console.log(Equal.equals(aRef, b))    // false (reference)
+ * console.log(Equal.equals(aRef, aRef)) // true  (same reference)
+ * console.log(aRef.x)                   // 1     (proxy reads through)
  * ```
  *
+ * @see {@link byReferenceUnsafe} — same effect without a proxy (mutates the
+ *   original)
+ * @see {@link equals} — the comparison function affected by this opt-out
+ *
  * @category utility
  * @since 2.0.0
  */
 export const byReference = obj => byReferenceUnsafe(new Proxy(obj, {}));
 /**
- * Marks an object to use reference equality instead of structural equality, without creating a proxy.
+ * Permanently marks an object to use reference equality, without creating a
+ * proxy.
+ *
+ * When to use:
+ * - When you want reference equality semantics and can accept that the
+ *   original object is **permanently** modified.
+ * - When proxy overhead is unacceptable (hot paths, large collections).
  *
- * Unlike `byReference`, this function directly modifies the object's equality behavior
- * without creating a proxy wrapper. This is more performant but "unsafe" because
- * it permanently changes how the object is compared.
+ * Behavior:
+ * - Adds `obj` to an internal WeakSet. From that point on, {@link equals}
+ *   treats it as reference-only.
+ * - Returns the **same** object (not a copy or proxy), so
+ *   `byReferenceUnsafe(x) === x`.
+ * - The marking is irreversible for the lifetime of the object.
+ * - Does **not** affect the object's prototype, properties, or behavior
+ *   beyond equality checks.
+ *
+ * **Example** (marking an object for reference equality)
  *
- * @example
  * ```ts
  * import { Equal } from "effect"
- * import * as assert from "node:assert"
  *
  * const obj1 = { a: 1, b: 2 }
  * const obj2 = { a: 1, b: 2 }
  *
- * // Mark obj1 for reference equality (modifies obj1 directly)
- * const obj1ByRef = Equal.byReferenceUnsafe(obj1)
- * assert(obj1ByRef === obj1) // Same object, no proxy created
- * assert(Equal.equals(obj1ByRef, obj2) === false) // uses reference equality
- * assert(Equal.equals(obj1ByRef, obj1ByRef) === true) // same reference
+ * Equal.byReferenceUnsafe(obj1)
  *
- * // The original obj1 is now permanently marked for reference equality
- * assert(Equal.equals(obj1, obj2) === false) // obj1 uses reference equality
+ * console.log(Equal.equals(obj1, obj2))   // false (reference)
+ * console.log(Equal.equals(obj1, obj1))   // true  (same reference)
+ * console.log(obj1 === Equal.byReferenceUnsafe(obj1)) // true (same object)
  * ```
  *
+ * @see {@link byReference} — safer alternative that creates a proxy
+ * @see {@link equals} — the comparison function affected by this opt-out
+ *
  * @category utility
  * @since 2.0.0
  */

package/dist/Equal.js.map

@@ -1 +1 @@
-{"version":3,"file":"Equal.js","names":["Hash","byReferenceInstances","getAllObjectKeys","hasProperty","symbol","equals","arguments","length","self","compareBoth","that","selfType","has","withCache","compareObjects","withVisitedTracking","fn","hasLeft","visitedLeft","hasRight","visitedRight","add","result","delete","WeakSet","hash","Date","toISOString","RegExp","toString","selfIsEqual","isEqual","thatIsEqual","bothEquals","Array","isArray","compareArrays","Map","size","compareMaps","Set","compareSets","compareRecords","f","selfMap","equalityCache","get","WeakMap","set","thatMap","i","selfKeys","thatKeys","key","makeCompareMap","keyEquivalence","valueEquivalence","selfKey","selfValue","found","thatKey","thatValue","makeCompareSet","equivalence","u","asEquivalence","byReference","obj","byReferenceUnsafe","Proxy"],"sources":["../src/Equal.ts"],"sourcesContent":[null],"mappings":"AAQA,OAAO,KAAKA,IAAI,MAAM,WAAW;AACjC,SAASC,oBAAoB,EAAEC,gBAAgB,QAAQ,qBAAqB;AAC5E,SAASC,WAAW,QAAQ,gBAAgB;AAE5C;;;;;AAKA,OAAO,MAAMC,MAAM,GAAG,0BAA0B;AAiGhD,OAAM,SAAUC,MAAMA,CAAA;EACpB,IAAIC,SAAS,CAACC,MAAM,KAAK,CAAC,EAAE;IAC1B,OAAQC,IAAa,IAAKC,WAAW,CAACD,IAAI,EAAEF,SAAS,CAAC,CAAC,CAAC,CAAC;EAC3D;EACA,OAAOG,WAAW,CAACH,SAAS,CAAC,CAAC,CAAC,EAAEA,SAAS,CAAC,CAAC,CAAC,CAAC;AAChD;AAEA,SAASG,WAAWA,CAACD,IAAa,EAAEE,IAAa;EAC/C,IAAIF,IAAI,KAAKE,IAAI,EAAE,OAAO,IAAI;EAC9B,IAAIF,IAAI,IAAI,IAAI,IAAIE,IAAI,IAAI,IAAI,EAAE,OAAO,KAAK;EAC9C,MAAMC,QAAQ,GAAG,OAAOH,IAAI;EAC5B,IAAIG,QAAQ,KAAK,OAAOD,IAAI,EAAE;IAC5B,OAAO,KAAK;EACd;EACA;EACA,IAAIC,QAAQ,KAAK,QAAQ,IAAIH,IAAI,KAAKA,IAAI,IAAIE,IAAI,KAAKA,IAAI,EAAE;IAC3D,OAAO,IAAI;EACb;EACA,IAAIC,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,KAAK,UAAU,EAAE;IACpD,OAAO,KAAK;EACd;EAEA,IAAIV,oBAAoB,CAACW,GAAG,CAACJ,IAAI,CAAC,IAAIP,oBAAoB,CAACW,GAAG,CAACF,IAAI,CAAC,EAAE;IACpE,OAAO,KAAK;EACd;EAEA;EACA,OAAOG,SAAS,CAACL,IAAI,EAAEE,IAAI,EAAEI,cAAc,CAAC;AAC9C;AAEA;AACA,SAASC,mBAAmBA,CAC1BP,IAAY,EACZE,IAAY,EACZM,EAAiB;EAEjB,MAAMC,OAAO,GAAGC,WAAW,CAACN,GAAG,CAACJ,IAAI,CAAC;EACrC,MAAMW,QAAQ,GAAGC,YAAY,CAACR,GAAG,CAACF,IAAI,CAAC;EACvC;EACA,IAAIO,OAAO,IAAIE,QAAQ,EAAE;IACvB,OAAO,IAAI,EAAC;EACd;EACA,IAAIF,OAAO,IAAIE,QAAQ,EAAE;IACvB,OAAO,KAAK,EAAC;EACf;EACAD,WAAW,CAACG,GAAG,CAACb,IAAI,CAAC;EACrBY,YAAY,CAACC,GAAG,CAACX,IAAI,CAAC;EACtB,MAAMY,MAAM,GAAGN,EAAE,EAAE;EACnBE,WAAW,CAACK,MAAM,CAACf,IAAI,CAAC;EACxBY,YAAY,CAACG,MAAM,CAACb,IAAI,CAAC;EACzB,OAAOY,MAAM;AACf;AAEA,MAAMJ,WAAW,gBAAG,IAAIM,OAAO,EAAU;AACzC,MAAMJ,YAAY,gBAAG,IAAII,OAAO,EAAU;AAE1C;AACA,SAASV,cAAcA,CAACN,IAAY,EAAEE,IAAY;EAChD,IAAIV,IAAI,CAACyB,IAAI,CAACjB,IAAI,CAAC,KAAKR,IAAI,CAACyB,IAAI,CAACf,IAAI,CAAC,EAAE;IACvC,OAAO,KAAK;EACd,CAAC,MAAM,IAAIF,IAAI,YAAYkB,IAAI,EAAE;IAC/B,IAAI,EAAEhB,IAAI,YAAYgB,IAAI,CAAC,EAAE,OAAO,KAAK;IACzC,OAAOlB,IAAI,CAACmB,WAAW,EAAE,KAAKjB,IAAI,CAACiB,WAAW,EAAE;EAClD,CAAC,MAAM,IAAInB,IAAI,YAAYoB,MAAM,EAAE;IACjC,IAAI,EAAElB,IAAI,YAAYkB,MAAM,CAAC,EAAE,OAAO,KAAK;IAC3C,OAAOpB,IAAI,CAACqB,QAAQ,EAAE,KAAKnB,IAAI,CAACmB,QAAQ,EAAE;EAC5C;EACA,MAAMC,WAAW,GAAGC,OAAO,CAACvB,IAAI,CAAC;EACjC,MAAMwB,WAAW,GAAGD,OAAO,CAACrB,IAAI,CAAC;EACjC,IAAIoB,WAAW,KAAKE,WAAW,EAAE,OAAO,KAAK;EAC7C,MAAMC,UAAU,GAAGH,WAAW,IAAIE,WAAW;EAC7C,IAAI,OAAOxB,IAAI,KAAK,UAAU,IAAI,CAACyB,UAAU,EAAE;IAC7C,OAAO,KAAK;EACd;EACA,OAAOlB,mBAAmB,CAACP,IAAI,EAAEE,IAAI,EAAE,MAAK;IAC1C,IAAIuB,UAAU,EAAE;MACd,OAAQzB,IAAY,CAACJ,MAAM,CAAC,CAACM,IAAI,CAAC;IACpC,CAAC,MAAM,IAAIwB,KAAK,CAACC,OAAO,CAAC3B,IAAI,CAAC,EAAE;MAC9B,IAAI,CAAC0B,KAAK,CAACC,OAAO,CAACzB,IAAI,CAAC,IAAIF,IAAI,CAACD,MAAM,KAAKG,IAAI,CAACH,MAAM,EAAE;QACvD,OAAO,KAAK;MACd;MACA,OAAO6B,aAAa,CAAC5B,IAAI,EAAEE,IAAI,CAAC;IAClC,CAAC,MAAM,IAAIF,IAAI,YAAY6B,GAAG,EAAE;MAC9B,IAAI,EAAE3B,IAAI,YAAY2B,GAAG,CAAC,IAAI7B,IAAI,CAAC8B,IAAI,KAAK5B,IAAI,CAAC4B,IAAI,EAAE;QACrD,OAAO,KAAK;MACd;MACA,OAAOC,WAAW,CAAC/B,IAAI,EAAEE,IAAI,CAAC;IAChC,CAAC,MAAM,IAAIF,IAAI,YAAYgC,GAAG,EAAE;MAC9B,IAAI,EAAE9B,IAAI,YAAY8B,GAAG,CAAC,IAAIhC,IAAI,CAAC8B,IAAI,KAAK5B,IAAI,CAAC4B,IAAI,EAAE;QACrD,OAAO,KAAK;MACd;MACA,OAAOG,WAAW,CAACjC,IAAI,EAAEE,IAAI,CAAC;IAChC;IACA,OAAOgC,cAAc,CAAClC,IAAW,EAAEE,IAAW,CAAC;EACjD,CAAC,CAAC;AACJ;AAEA,SAASG,SAASA,CAACL,IAAY,EAAEE,IAAY,EAAEiC,CAA8B;EAC3E;EACA,IAAIC,OAAO,GAAGC,aAAa,CAACC,GAAG,CAACtC,IAAI,CAAC;EACrC,IAAI,CAACoC,OAAO,EAAE;IACZA,OAAO,GAAG,IAAIG,OAAO,EAAE;IACvBF,aAAa,CAACG,GAAG,CAACxC,IAAI,EAAEoC,OAAO,CAAC;EAClC,CAAC,MAAM,IAAIA,OAAO,CAAChC,GAAG,CAACF,IAAI,CAAC,EAAE;IAC5B,OAAOkC,OAAO,CAACE,GAAG,CAACpC,IAAI,CAAE;EAC3B;EAEA;EACA,MAAMY,MAAM,GAAGqB,CAAC,CAACnC,IAAI,EAAEE,IAAI,CAAC;EAE5B;EACAkC,OAAO,CAACI,GAAG,CAACtC,IAAI,EAAEY,MAAM,CAAC;EAEzB,IAAI2B,OAAO,GAAGJ,aAAa,CAACC,GAAG,CAACpC,IAAI,CAAC;EACrC,IAAI,CAACuC,OAAO,EAAE;IACZA,OAAO,GAAG,IAAIF,OAAO,EAAE;IACvBF,aAAa,CAACG,GAAG,CAACtC,IAAI,EAAEuC,OAAO,CAAC;EAClC;EACAA,OAAO,CAACD,GAAG,CAACxC,IAAI,EAAEc,MAAM,CAAC;EAEzB,OAAOA,MAAM;AACf;AAEA,MAAMuB,aAAa,gBAAG,IAAIE,OAAO,EAAoC;AAErE,SAASX,aAAaA,CAAC5B,IAAoB,EAAEE,IAAoB;EAC/D,KAAK,IAAIwC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAG1C,IAAI,CAACD,MAAM,EAAE2C,CAAC,EAAE,EAAE;IACpC,IAAI,CAACzC,WAAW,CAACD,IAAI,CAAC0C,CAAC,CAAC,EAAExC,IAAI,CAACwC,CAAC,CAAC,CAAC,EAAE;MAClC,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb;AAEA,SAASR,cAAcA,CACrBlC,IAAkC,EAClCE,IAAkC;EAElC,MAAMyC,QAAQ,GAAGjD,gBAAgB,CAACM,IAAI,CAAC;EACvC,MAAM4C,QAAQ,GAAGlD,gBAAgB,CAACQ,IAAI,CAAC;EAEvC,IAAIyC,QAAQ,CAACb,IAAI,KAAKc,QAAQ,CAACd,IAAI,EAAE;IACnC,OAAO,KAAK;EACd;EAEA,KAAK,MAAMe,GAAG,IAAIF,QAAQ,EAAE;IAC1B,IAAI,CAAEC,QAAQ,CAACxC,GAAG,CAACyC,GAAG,CAAE,IAAI,CAAC5C,WAAW,CAACD,IAAI,CAAC6C,GAAG,CAAC,EAAE3C,IAAI,CAAC2C,GAAG,CAAC,CAAC,EAAE;MAC9D,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb;AAEA;AACA,OAAM,SAAUC,cAAcA,CAAOC,cAA8B,EAAEC,gBAAgC;EACnG,OAAO,SAASjB,WAAWA,CAAC/B,IAAuB,EAAEE,IAAuB;IAC1E,KAAK,MAAM,CAAC+C,OAAO,EAAEC,SAAS,CAAC,IAAIlD,IAAI,EAAE;MACvC,IAAImD,KAAK,GAAG,KAAK;MACjB,KAAK,MAAM,CAACC,OAAO,EAAEC,SAAS,CAAC,IAAInD,IAAI,EAAE;QACvC,IAAI6C,cAAc,CAACE,OAAO,EAAEG,OAAO,CAAC,IAAIJ,gBAAgB,CAACE,SAAS,EAAEG,SAAS,CAAC,EAAE;UAC9EF,KAAK,GAAG,IAAI;UACZ;QACF;MACF;MACA,IAAI,CAACA,KAAK,EAAE;QACV,OAAO,KAAK;MACd;IACF;IAEA,OAAO,IAAI;EACb,CAAC;AACH;AAEA,MAAMpB,WAAW,gBAAGe,cAAc,CAAC7C,WAAW,EAAEA,WAAW,CAAC;AAE5D;AACA,OAAM,SAAUqD,cAAcA,CAAIC,WAA2B;EAC3D,OAAO,SAAStB,WAAWA,CAACjC,IAAoB,EAAEE,IAAoB;IACpE,KAAK,MAAMgD,SAAS,IAAIlD,IAAI,EAAE;MAC5B,IAAImD,KAAK,GAAG,KAAK;MACjB,KAAK,MAAME,SAAS,IAAInD,IAAI,EAAE;QAC5B,IAAIqD,WAAW,CAACL,SAAS,EAAEG,SAAS,CAAC,EAAE;UACrCF,KAAK,GAAG,IAAI;UACZ;QACF;MACF;MACA,IAAI,CAACA,KAAK,EAAE;QACV,OAAO,KAAK;MACd;IACF;IAEA,OAAO,IAAI;EACb,CAAC;AACH;AAEA,MAAMlB,WAAW,gBAAGqB,cAAc,CAACrD,WAAW,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAMsB,OAAO,GAAIiC,CAAU,IAAiB7D,WAAW,CAAC6D,CAAC,EAAE5D,MAAM,CAAC;AAEzE;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAM6D,aAAa,GAA4BA,CAAA,KAAM5D,MAAM;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,OAAO,MAAM6D,WAAW,GAAsBC,GAAM,IAAQC,iBAAiB,CAAC,IAAIC,KAAK,CAACF,GAAG,EAAE,EAAE,CAAC,CAAC;AAEjG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,MAAMC,iBAAiB,GAAsBD,GAAM,IAAO;EAC/DlE,oBAAoB,CAACoB,GAAG,CAAC8C,GAAG,CAAC;EAC7B,OAAOA,GAAG;AACZ,CAAC","ignoreList":[]}
+{"version":3,"file":"Equal.js","names":["Hash","byReferenceInstances","getAllObjectKeys","hasProperty","symbol","equals","arguments","length","self","compareBoth","that","selfType","has","withCache","compareObjects","withVisitedTracking","fn","hasLeft","visitedLeft","hasRight","visitedRight","add","result","delete","WeakSet","hash","Date","toISOString","RegExp","toString","selfIsEqual","isEqual","thatIsEqual","bothEquals","Array","isArray","compareArrays","Map","size","compareMaps","Set","compareSets","compareRecords","f","selfMap","equalityCache","get","WeakMap","set","thatMap","i","selfKeys","thatKeys","key","makeCompareMap","keyEquivalence","valueEquivalence","selfKey","selfValue","found","thatKey","thatValue","makeCompareSet","equivalence","u","asEquivalence","byReference","obj","byReferenceUnsafe","Proxy"],"sources":["../src/Equal.ts"],"sourcesContent":[null],"mappings":"AAwEA,OAAO,KAAKA,IAAI,MAAM,WAAW;AACjC,SAASC,oBAAoB,EAAEC,gBAAgB,QAAQ,qBAAqB;AAC5E,SAASC,WAAW,QAAQ,gBAAgB;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,OAAO,MAAMC,MAAM,GAAG,0BAA0B;AA4HhD,OAAM,SAAUC,MAAMA,CAAA;EACpB,IAAIC,SAAS,CAACC,MAAM,KAAK,CAAC,EAAE;IAC1B,OAAQC,IAAa,IAAKC,WAAW,CAACD,IAAI,EAAEF,SAAS,CAAC,CAAC,CAAC,CAAC;EAC3D;EACA,OAAOG,WAAW,CAACH,SAAS,CAAC,CAAC,CAAC,EAAEA,SAAS,CAAC,CAAC,CAAC,CAAC;AAChD;AAEA,SAASG,WAAWA,CAACD,IAAa,EAAEE,IAAa;EAC/C,IAAIF,IAAI,KAAKE,IAAI,EAAE,OAAO,IAAI;EAC9B,IAAIF,IAAI,IAAI,IAAI,IAAIE,IAAI,IAAI,IAAI,EAAE,OAAO,KAAK;EAC9C,MAAMC,QAAQ,GAAG,OAAOH,IAAI;EAC5B,IAAIG,QAAQ,KAAK,OAAOD,IAAI,EAAE;IAC5B,OAAO,KAAK;EACd;EACA;EACA,IAAIC,QAAQ,KAAK,QAAQ,IAAIH,IAAI,KAAKA,IAAI,IAAIE,IAAI,KAAKA,IAAI,EAAE;IAC3D,OAAO,IAAI;EACb;EACA,IAAIC,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,KAAK,UAAU,EAAE;IACpD,OAAO,KAAK;EACd;EAEA,IAAIV,oBAAoB,CAACW,GAAG,CAACJ,IAAI,CAAC,IAAIP,oBAAoB,CAACW,GAAG,CAACF,IAAI,CAAC,EAAE;IACpE,OAAO,KAAK;EACd;EAEA;EACA,OAAOG,SAAS,CAACL,IAAI,EAAEE,IAAI,EAAEI,cAAc,CAAC;AAC9C;AAEA;AACA,SAASC,mBAAmBA,CAC1BP,IAAY,EACZE,IAAY,EACZM,EAAiB;EAEjB,MAAMC,OAAO,GAAGC,WAAW,CAACN,GAAG,CAACJ,IAAI,CAAC;EACrC,MAAMW,QAAQ,GAAGC,YAAY,CAACR,GAAG,CAACF,IAAI,CAAC;EACvC;EACA,IAAIO,OAAO,IAAIE,QAAQ,EAAE;IACvB,OAAO,IAAI,EAAC;EACd;EACA,IAAIF,OAAO,IAAIE,QAAQ,EAAE;IACvB,OAAO,KAAK,EAAC;EACf;EACAD,WAAW,CAACG,GAAG,CAACb,IAAI,CAAC;EACrBY,YAAY,CAACC,GAAG,CAACX,IAAI,CAAC;EACtB,MAAMY,MAAM,GAAGN,EAAE,EAAE;EACnBE,WAAW,CAACK,MAAM,CAACf,IAAI,CAAC;EACxBY,YAAY,CAACG,MAAM,CAACb,IAAI,CAAC;EACzB,OAAOY,MAAM;AACf;AAEA,MAAMJ,WAAW,gBAAG,IAAIM,OAAO,EAAU;AACzC,MAAMJ,YAAY,gBAAG,IAAII,OAAO,EAAU;AAE1C;AACA,SAASV,cAAcA,CAACN,IAAY,EAAEE,IAAY;EAChD,IAAIV,IAAI,CAACyB,IAAI,CAACjB,IAAI,CAAC,KAAKR,IAAI,CAACyB,IAAI,CAACf,IAAI,CAAC,EAAE;IACvC,OAAO,KAAK;EACd,CAAC,MAAM,IAAIF,IAAI,YAAYkB,IAAI,EAAE;IAC/B,IAAI,EAAEhB,IAAI,YAAYgB,IAAI,CAAC,EAAE,OAAO,KAAK;IACzC,OAAOlB,IAAI,CAACmB,WAAW,EAAE,KAAKjB,IAAI,CAACiB,WAAW,EAAE;EAClD,CAAC,MAAM,IAAInB,IAAI,YAAYoB,MAAM,EAAE;IACjC,IAAI,EAAElB,IAAI,YAAYkB,MAAM,CAAC,EAAE,OAAO,KAAK;IAC3C,OAAOpB,IAAI,CAACqB,QAAQ,EAAE,KAAKnB,IAAI,CAACmB,QAAQ,EAAE;EAC5C;EACA,MAAMC,WAAW,GAAGC,OAAO,CAACvB,IAAI,CAAC;EACjC,MAAMwB,WAAW,GAAGD,OAAO,CAACrB,IAAI,CAAC;EACjC,IAAIoB,WAAW,KAAKE,WAAW,EAAE,OAAO,KAAK;EAC7C,MAAMC,UAAU,GAAGH,WAAW,IAAIE,WAAW;EAC7C,IAAI,OAAOxB,IAAI,KAAK,UAAU,IAAI,CAACyB,UAAU,EAAE;IAC7C,OAAO,KAAK;EACd;EACA,OAAOlB,mBAAmB,CAACP,IAAI,EAAEE,IAAI,EAAE,MAAK;IAC1C,IAAIuB,UAAU,EAAE;MACd,OAAQzB,IAAY,CAACJ,MAAM,CAAC,CAACM,IAAI,CAAC;IACpC,CAAC,MAAM,IAAIwB,KAAK,CAACC,OAAO,CAAC3B,IAAI,CAAC,EAAE;MAC9B,IAAI,CAAC0B,KAAK,CAACC,OAAO,CAACzB,IAAI,CAAC,IAAIF,IAAI,CAACD,MAAM,KAAKG,IAAI,CAACH,MAAM,EAAE;QACvD,OAAO,KAAK;MACd;MACA,OAAO6B,aAAa,CAAC5B,IAAI,EAAEE,IAAI,CAAC;IAClC,CAAC,MAAM,IAAIF,IAAI,YAAY6B,GAAG,EAAE;MAC9B,IAAI,EAAE3B,IAAI,YAAY2B,GAAG,CAAC,IAAI7B,IAAI,CAAC8B,IAAI,KAAK5B,IAAI,CAAC4B,IAAI,EAAE;QACrD,OAAO,KAAK;MACd;MACA,OAAOC,WAAW,CAAC/B,IAAI,EAAEE,IAAI,CAAC;IAChC,CAAC,MAAM,IAAIF,IAAI,YAAYgC,GAAG,EAAE;MAC9B,IAAI,EAAE9B,IAAI,YAAY8B,GAAG,CAAC,IAAIhC,IAAI,CAAC8B,IAAI,KAAK5B,IAAI,CAAC4B,IAAI,EAAE;QACrD,OAAO,KAAK;MACd;MACA,OAAOG,WAAW,CAACjC,IAAI,EAAEE,IAAI,CAAC;IAChC;IACA,OAAOgC,cAAc,CAAClC,IAAW,EAAEE,IAAW,CAAC;EACjD,CAAC,CAAC;AACJ;AAEA,SAASG,SAASA,CAACL,IAAY,EAAEE,IAAY,EAAEiC,CAA8B;EAC3E;EACA,IAAIC,OAAO,GAAGC,aAAa,CAACC,GAAG,CAACtC,IAAI,CAAC;EACrC,IAAI,CAACoC,OAAO,EAAE;IACZA,OAAO,GAAG,IAAIG,OAAO,EAAE;IACvBF,aAAa,CAACG,GAAG,CAACxC,IAAI,EAAEoC,OAAO,CAAC;EAClC,CAAC,MAAM,IAAIA,OAAO,CAAChC,GAAG,CAACF,IAAI,CAAC,EAAE;IAC5B,OAAOkC,OAAO,CAACE,GAAG,CAACpC,IAAI,CAAE;EAC3B;EAEA;EACA,MAAMY,MAAM,GAAGqB,CAAC,CAACnC,IAAI,EAAEE,IAAI,CAAC;EAE5B;EACAkC,OAAO,CAACI,GAAG,CAACtC,IAAI,EAAEY,MAAM,CAAC;EAEzB,IAAI2B,OAAO,GAAGJ,aAAa,CAACC,GAAG,CAACpC,IAAI,CAAC;EACrC,IAAI,CAACuC,OAAO,EAAE;IACZA,OAAO,GAAG,IAAIF,OAAO,EAAE;IACvBF,aAAa,CAACG,GAAG,CAACtC,IAAI,EAAEuC,OAAO,CAAC;EAClC;EACAA,OAAO,CAACD,GAAG,CAACxC,IAAI,EAAEc,MAAM,CAAC;EAEzB,OAAOA,MAAM;AACf;AAEA,MAAMuB,aAAa,gBAAG,IAAIE,OAAO,EAAoC;AAErE,SAASX,aAAaA,CAAC5B,IAAoB,EAAEE,IAAoB;EAC/D,KAAK,IAAIwC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAG1C,IAAI,CAACD,MAAM,EAAE2C,CAAC,EAAE,EAAE;IACpC,IAAI,CAACzC,WAAW,CAACD,IAAI,CAAC0C,CAAC,CAAC,EAAExC,IAAI,CAACwC,CAAC,CAAC,CAAC,EAAE;MAClC,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb;AAEA,SAASR,cAAcA,CACrBlC,IAAkC,EAClCE,IAAkC;EAElC,MAAMyC,QAAQ,GAAGjD,gBAAgB,CAACM,IAAI,CAAC;EACvC,MAAM4C,QAAQ,GAAGlD,gBAAgB,CAACQ,IAAI,CAAC;EAEvC,IAAIyC,QAAQ,CAACb,IAAI,KAAKc,QAAQ,CAACd,IAAI,EAAE;IACnC,OAAO,KAAK;EACd;EAEA,KAAK,MAAMe,GAAG,IAAIF,QAAQ,EAAE;IAC1B,IAAI,CAAEC,QAAQ,CAACxC,GAAG,CAACyC,GAAG,CAAE,IAAI,CAAC5C,WAAW,CAACD,IAAI,CAAC6C,GAAG,CAAC,EAAE3C,IAAI,CAAC2C,GAAG,CAAC,CAAC,EAAE;MAC9D,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb;AAEA;AACA,OAAM,SAAUC,cAAcA,CAAOC,cAA8B,EAAEC,gBAAgC;EACnG,OAAO,SAASjB,WAAWA,CAAC/B,IAAsB,EAAEE,IAAsB;IACxE,KAAK,MAAM,CAAC+C,OAAO,EAAEC,SAAS,CAAC,IAAIlD,IAAI,EAAE;MACvC,IAAImD,KAAK,GAAG,KAAK;MACjB,KAAK,MAAM,CAACC,OAAO,EAAEC,SAAS,CAAC,IAAInD,IAAI,EAAE;QACvC,IAAI6C,cAAc,CAACE,OAAO,EAAEG,OAAO,CAAC,IAAIJ,gBAAgB,CAACE,SAAS,EAAEG,SAAS,CAAC,EAAE;UAC9EF,KAAK,GAAG,IAAI;UACZ;QACF;MACF;MACA,IAAI,CAACA,KAAK,EAAE;QACV,OAAO,KAAK;MACd;IACF;IAEA,OAAO,IAAI;EACb,CAAC;AACH;AAEA,MAAMpB,WAAW,gBAAGe,cAAc,CAAC7C,WAAW,EAAEA,WAAW,CAAC;AAE5D;AACA,OAAM,SAAUqD,cAAcA,CAAIC,WAA2B;EAC3D,OAAO,SAAStB,WAAWA,CAACjC,IAAiB,EAAEE,IAAiB;IAC9D,KAAK,MAAMgD,SAAS,IAAIlD,IAAI,EAAE;MAC5B,IAAImD,KAAK,GAAG,KAAK;MACjB,KAAK,MAAME,SAAS,IAAInD,IAAI,EAAE;QAC5B,IAAIqD,WAAW,CAACL,SAAS,EAAEG,SAAS,CAAC,EAAE;UACrCF,KAAK,GAAG,IAAI;UACZ;QACF;MACF;MACA,IAAI,CAACA,KAAK,EAAE;QACV,OAAO,KAAK;MACd;IACF;IAEA,OAAO,IAAI;EACb,CAAC;AACH;AAEA,MAAMlB,WAAW,gBAAGqB,cAAc,CAACrD,WAAW,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,OAAO,MAAMsB,OAAO,GAAIiC,CAAU,IAAiB7D,WAAW,CAAC6D,CAAC,EAAE5D,MAAM,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAM6D,aAAa,GAA4BA,CAAA,KAAM5D,MAAM;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,OAAO,MAAM6D,WAAW,GAAsBC,GAAM,IAAQC,iBAAiB,CAAC,IAAIC,KAAK,CAACF,GAAG,EAAE,EAAE,CAAC,CAAC;AAEjG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,OAAO,MAAMC,iBAAiB,GAAsBD,GAAM,IAAO;EAC/DlE,oBAAoB,CAACoB,GAAG,CAAC8C,GAAG,CAAC;EAC7B,OAAOA,GAAG;AACZ,CAAC","ignoreList":[]}

package/dist/ErrorReporter.d.ts

@@ -0,0 +1,376 @@
+/**
+ * Pluggable error reporting for Effect programs.
+ *
+ * Reporting is triggered by `Effect.withErrorReporting`,
+ * `ErrorReporter.report`, or built-in reporting boundaries in the HTTP and
+ * RPC server modules.
+ *
+ * Each reporter receives a structured callback with the failing `Cause`, a
+ * pretty-printed `Error`, severity, and any extra attributes attached to the
+ * original error — making it straightforward to forward failures to Sentry,
+ * Datadog, or a custom logging backend.
+ *
+ * Use the annotation symbols (`ignore`, `severity`, `attributes`) on your
+ * error classes to control reporting behavior per-error.
+ *
+ * @example
+ * ```ts
+ * import { Data, Effect, ErrorReporter } from "effect"
+ *
+ * // A reporter that logs to the console
+ * const consoleReporter = ErrorReporter.make(({ error, severity }) => {
+ *   console.error(`[${severity}]`, error.message)
+ * })
+ *
+ * // An error that should be ignored by reporters
+ * class NotFoundError extends Data.TaggedError("NotFoundError")<{}> {
+ *   readonly [ErrorReporter.ignore] = true
+ * }
+ *
+ * // An error with custom severity and attributes
+ * class RateLimitError extends Data.TaggedError("RateLimitError")<{
+ *   readonly retryAfter: number
+ * }> {
+ *   readonly [ErrorReporter.severity] = "Warn" as const
+ *   readonly [ErrorReporter.attributes] = {
+ *     retryAfter: this.retryAfter
+ *   }
+ * }
+ *
+ * // Opt in to error reporting with Effect.withErrorReporting
+ * const program = Effect.gen(function*() {
+ *   yield* new RateLimitError({ retryAfter: 60 })
+ * }).pipe(
+ *   Effect.withErrorReporting,
+ *   Effect.provide(ErrorReporter.layer([consoleReporter]))
+ * )
+ * ```
+ *
+ * @since 4.0.0
+ */
+import type * as Cause from "./Cause.ts";
+import * as Effect from "./Effect.ts";
+import type * as Fiber from "./Fiber.ts";
+import * as Layer from "./Layer.ts";
+import type { Severity } from "./LogLevel.ts";
+import type { ReadonlyRecord } from "./Record.ts";
+import type * as Scope from "./Scope.ts";
+import type * as ServiceMap from "./ServiceMap.ts";
+/**
+ * @since 4.0.0
+ * @category Type Identifiers
+ */
+export type TypeId = "~effect/ErrorReporter";
+/**
+ * @since 4.0.0
+ * @category Type Identifiers
+ */
+export declare const TypeId: TypeId;
+/**
+ * An `ErrorReporter` receives reported failures and forwards them to an
+ * external system (logging service, error tracker, etc.).
+ *
+ * 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
+ * and per-error annotation extraction automatically.
+ *
+ * @since 4.0.0
+ * @category Models
+ */
+export interface ErrorReporter {
+    readonly [TypeId]: TypeId;
+    report(options: {
+        readonly cause: Cause.Cause<unknown>;
+        readonly fiber: Fiber.Fiber<unknown, unknown>;
+        readonly timestamp: bigint;
+    }): void;
+}
+/**
+ * Creates an `ErrorReporter` from a callback.
+ *
+ * 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
+ * each error before invoking your callback.
+ *
+ * @example
+ * ```ts
+ * import { ErrorReporter } from "effect"
+ *
+ * // Forward every failure to the console
+ * const consoleReporter = ErrorReporter.make(
+ *   ({ error, severity, attributes }) => {
+ *     console.error(`[${severity}]`, error.message, attributes)
+ *   }
+ * )
+ * ```
+ *
+ * @since 4.0.0
+ * @category Constructors
+ */
+export declare const make: (report: (options: {
+    readonly cause: Cause.Cause<unknown>;
+    readonly error: Error;
+    readonly attributes: ReadonlyRecord<string, unknown>;
+    readonly severity: Severity;
+    readonly fiber: Fiber.Fiber<unknown, unknown>;
+    readonly timestamp: bigint;
+}) => void) => ErrorReporter;
+/**
+ * A `ServiceMap.Reference` holding the set of active `ErrorReporter`s for the
+ * current fiber. Defaults to an empty set (no reporting).
+ *
+ * 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`).
+ *
+ * @since 4.0.0
+ * @category References
+ */
+export declare const CurrentErrorReporters: ServiceMap.Reference<ReadonlySet<ErrorReporter>>;
+/**
+ * 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.
+ *
+ * By default the provided reporters **replace** any previously registered
+ * reporters. Set `mergeWithExisting: true` to add them alongside existing
+ * ones.
+ *
+ * @example
+ * ```ts
+ * import { Effect, ErrorReporter } from "effect"
+ *
+ * const consoleReporter = ErrorReporter.make(({ error, severity }) => {
+ *   console.error(`[${severity}]`, error.message)
+ * })
+ *
+ * const metricsReporter = ErrorReporter.make(({ severity }) => {
+ *   // increment an error counter by severity
+ * })
+ *
+ * // Replace all existing reporters
+ * const ReporterLive = ErrorReporter.layer([
+ *   consoleReporter,
+ *   metricsReporter
+ * ])
+ *
+ * // Add to existing reporters instead of replacing
+ * const ReporterMerged = ErrorReporter.layer(
+ *   [metricsReporter],
+ *   { mergeWithExisting: true }
+ * )
+ *
+ * const program = Effect.gen(function*() {
+ *   yield* Effect.fail("boom")
+ * }).pipe(
+ *   Effect.withErrorReporting,
+ *   Effect.provide(ReporterLive)
+ * )
+ * ```
+ *
+ * @since 4.0.0
+ * @category Layers
+ */
+export declare const layer: <const Reporters extends ReadonlyArray<ErrorReporter | Effect.Effect<ErrorReporter, any, any>>>(reporters: Reporters, options?: {
+    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
+ * current fiber.
+ *
+ * This is useful when you want to report an error for observability without
+ * actually failing the fiber.
+ *
+ * @example
+ * ```ts
+ * import { Cause, Effect, ErrorReporter } from "effect"
+ *
+ * // Log the cause for monitoring, then continue with a fallback
+ * const program = Effect.gen(function*() {
+ *   const cause = Cause.fail("something went wrong")
+ *   yield* ErrorReporter.report(cause)
+ *   return "fallback value"
+ * })
+ * ```
+ *
+ * @since 4.0.0
+ * @category Reporting
+ */
+export declare const report: <E>(cause: Cause.Cause<E>) => Effect.Effect<void>;
+/**
+ * Interface that errors can implement to control reporting behavior.
+ *
+ * All three annotation properties are optional:
+ * - `[ErrorReporter.ignore]` — when `true`, the error is never reported
+ * - `[ErrorReporter.severity]` — overrides the default `"Error"` severity
+ * - `[ErrorReporter.attributes]` — extra key/value pairs forwarded to reporters
+ *
+ * The global `Error` interface is augmented with `Reportable`, so these
+ * properties are available on all `Error` instances.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export interface Reportable {
+    readonly [ignore]?: boolean;
+    readonly [severity]?: Severity;
+    readonly [attributes]?: ReadonlyRecord<string, unknown>;
+}
+declare global {
+    interface Error extends Reportable {
+    }
+}
+/**
+ * Symbol key used to mark an error as unreportable.
+ *
+ * Set this property to `true` on any error class to prevent it from being
+ * forwarded to reporters. Useful for expected errors such as HTTP 404s.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class NotFoundError extends Data.TaggedError("NotFoundError")<{}> {
+ *   readonly [ErrorReporter.ignore] = true
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export type ignore = "~effect/ErrorReporter/ignore";
+/**
+ * Symbol key used to mark an error as unreportable.
+ *
+ * Set this property to `true` on any error class to prevent it from being
+ * forwarded to reporters. Useful for expected errors such as HTTP 404s.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class NotFoundError extends Data.TaggedError("NotFoundError")<{}> {
+ *   readonly [ErrorReporter.ignore] = true
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export declare const ignore: ignore;
+/**
+ * Returns `true` if the given value has the `ErrorReporter.ignore` annotation
+ * set to `true`.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export declare const isIgnored: (u: unknown) => boolean;
+/**
+ * Symbol key used to override the severity level of an error.
+ *
+ * When set, the reporter callback receives this value as `severity` instead
+ * of the default `"Error"`. Accepted values are the `LogLevel.Severity`
+ * literals: `"Trace"`, `"Debug"`, `"Info"`, `"Warn"`, `"Error"`, `"Fatal"`.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
+ *   readonly [ErrorReporter.severity] = "Warn" as const
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export type severity = "~effect/ErrorReporter/severity";
+/**
+ * Symbol key used to override the severity level of an error.
+ *
+ * When set, the reporter callback receives this value as `severity` instead
+ * of the default `"Error"`. Accepted values are the `LogLevel.Severity`
+ * literals: `"Trace"`, `"Debug"`, `"Info"`, `"Warn"`, `"Error"`, `"Fatal"`.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
+ *   readonly [ErrorReporter.severity] = "Warn" as const
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export declare const severity: severity;
+/**
+ * Reads the `ErrorReporter.severity` annotation from an error object,
+ * falling back to `"Error"` when unset or invalid.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export declare const getSeverity: (error: object) => Severity;
+/**
+ * Symbol key used to attach extra key/value metadata to an error report.
+ *
+ * Reporters receive these attributes alongside the error, making it easy to
+ * include contextual information such as user IDs, request IDs, or any
+ * domain-specific data useful for debugging.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class PaymentError extends Data.TaggedError("PaymentError")<{
+ *   readonly orderId: string
+ * }> {
+ *   readonly [ErrorReporter.attributes] = {
+ *     orderId: this.orderId
+ *   }
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export type attributes = "~effect/ErrorReporter/attributes";
+/**
+ * Symbol key used to attach extra key/value metadata to an error report.
+ *
+ * Reporters receive these attributes alongside the error, making it easy to
+ * include contextual information such as user IDs, request IDs, or any
+ * domain-specific data useful for debugging.
+ *
+ * @example
+ * ```ts
+ * import { Data, ErrorReporter } from "effect"
+ *
+ * class PaymentError extends Data.TaggedError("PaymentError")<{
+ *   readonly orderId: string
+ * }> {
+ *   readonly [ErrorReporter.attributes] = {
+ *     orderId: this.orderId
+ *   }
+ * }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export declare const attributes: attributes;
+/**
+ * Reads the `ErrorReporter.attributes` annotation from an error object,
+ * returning an empty record when unset.
+ *
+ * @since 4.0.0
+ * @category Annotations
+ */
+export declare const getAttributes: (error: object) => ReadonlyRecord<string, unknown>;
+//# sourceMappingURL=ErrorReporter.d.ts.map

package/dist/ErrorReporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorReporter.d.ts","sourceRoot":"","sources":["../src/ErrorReporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,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;AACxC,OAAO,KAAK,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAElD;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,uBAAuB,CAAA;AAE5C;;;GAGG;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;;;;;;;;;;;;;;;;;;;;;;GAsBG;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,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAgC,CAAA;AAEnH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;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;;;;;;;;;;;;;;;;;;;;;GAqBG;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;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,MAAM,GAAG,8BAA8B,CAAA;AAEnD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,EAAE,MAAuC,CAAA;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,OAAO,KAAG,OACmC,CAAA;AAE1E;;;;;;;;;;;;;;;;;;GAkBG;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;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,UAAU,GAAG,kCAAkC,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;;GAsBG;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"}