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

package/dist/ErrorReporter.d.ts

@@ -13,7 +13,8 @@
  * Use the annotation symbols (`ignore`, `severity`, `attributes`) on your
  * error classes to control reporting behavior per-error.
  *
- * @example
+ * **Example** (Reporting errors with annotations)
+ *
  * ```ts
  * import { Data, Effect, ErrorReporter } from "effect"
  *
@@ -57,13 +58,18 @@ import type { Severity } from "./LogLevel.ts";
 import type { ReadonlyRecord } from "./Record.ts";
 import type * as Scope from "./Scope.ts";
 /**
- * @since 4.0.0
+ * String literal type used as the runtime type identifier for
+ * `ErrorReporter` values.
+ *
  * @category Type Identifiers
+ * @since 4.0.0
  */
 export type TypeId = "~effect/ErrorReporter";
 /**
- * @since 4.0.0
+ * Runtime type identifier attached to `ErrorReporter` values.
+ *
  * @category Type Identifiers
+ * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
@@ -75,8 +81,8 @@ export declare const TypeId: TypeId;
  * modules. Use {@link make} to create a reporter — it handles deduplication
  * and per-error annotation extraction automatically.
  *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface ErrorReporter {
     readonly [TypeId]: TypeId;
@@ -94,7 +100,8 @@ export interface ErrorReporter {
  * and resolves the `ignore`, `severity`, and `attributes` annotations on
  * each error before invoking your callback.
  *
- * @example
+ * **Example** (Forwarding errors to the console)
+ *
  * ```ts
  * import { ErrorReporter } from "effect"
  *
@@ -106,8 +113,8 @@ export interface ErrorReporter {
  * )
  * ```
  *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export declare const make: (report: (options: {
     readonly cause: Cause.Cause<unknown>;
@@ -125,8 +132,8 @@ export declare const make: (report: (options: {
  * reference directly only when you need low-level control (e.g. reading the
  * current reporters or swapping them inside a `FiberRef`).
  *
+ * @category references
  * @since 4.0.0
- * @category References
  */
 export declare const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorReporter>>;
 /**
@@ -139,7 +146,8 @@ export declare const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorR
  * reporters. Set `mergeWithExisting: true` to add them alongside existing
  * ones.
  *
- * @example
+ * **Example** (Providing error reporters)
+ *
  * ```ts
  * import { Effect, ErrorReporter } from "effect"
  *
@@ -169,8 +177,8 @@ export declare const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorR
  * )
  * ```
  *
+ * @category layers
  * @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;
@@ -182,7 +190,8 @@ export declare const layer: <const Reporters extends ReadonlyArray<ErrorReporter
  * This is useful when you want to report an error for observability without
  * actually failing the fiber.
  *
- * @example
+ * **Example** (Reporting a cause manually)
+ *
  * ```ts
  * import { Cause, Effect, ErrorReporter } from "effect"
  *
@@ -194,23 +203,23 @@ export declare const layer: <const Reporters extends ReadonlyArray<ErrorReporter
  * })
  * ```
  *
- * @since 4.0.0
  * @category Reporting
+ * @since 4.0.0
  */
 export declare const report: <E>(cause: Cause.Cause<E>) => Effect.Effect<void>;
 /**
- * Interface that errors can implement to control reporting behavior.
+ * Interface that object 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
+ * - `[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
  *
  * The global `Error` interface is augmented with `Reportable`, so these
- * properties are available on all `Error` instances.
+ * properties are available on `Error` instances at the type level.
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export interface Reportable {
     readonly [ignore]?: boolean;
@@ -222,31 +231,27 @@ declare global {
     }
 }
 /**
- * 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.
+ * String property key used to mark an object error as ignored by error
+ * reporting.
  *
- * @example
- * ```ts
- * import { Data, ErrorReporter } from "effect"
- *
- * class NotFoundError extends Data.TaggedError("NotFoundError")<{}> {
- *   readonly [ErrorReporter.ignore] = true
- * }
- * ```
+ * 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.
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export type ignore = "~effect/ErrorReporter/ignore";
 /**
- * Symbol key used to mark an error as unreportable.
+ * Runtime property key used to mark an object error as ignored by error
+ * reporting.
  *
- * 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.
+ * 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.
+ *
+ * **Example** (Marking errors as ignored)
  *
- * @example
  * ```ts
  * import { Data, ErrorReporter } from "effect"
  *
@@ -255,46 +260,36 @@ export type ignore = "~effect/ErrorReporter/ignore";
  * }
  * ```
  *
+ * @category annotations
  * @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`.
  *
+ * @category annotations
  * @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"`.
+ * String property key used to override the severity level of an object error.
  *
- * @example
- * ```ts
- * import { Data, ErrorReporter } from "effect"
- *
- * class DeprecationWarning extends Data.TaggedError("DeprecationWarning")<{}> {
- *   readonly [ErrorReporter.severity] = "Warn" as const
- * }
- * ```
+ * When set to a valid `LogLevel.Severity`, the reporter callback receives this
+ * value as `severity`. Missing or invalid values fall back to `"Info"`.
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export type severity = "~effect/ErrorReporter/severity";
 /**
- * Symbol key used to override the severity level of an error.
+ * Runtime property key used to override the severity level of an object error.
+ *
+ * Set `error[ErrorReporter.severity]` to a valid `LogLevel.Severity` value.
+ * Missing or invalid values fall back to `"Info"`.
  *
- * 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** (Setting error severity annotations)
  *
- * @example
  * ```ts
  * import { Data, ErrorReporter } from "effect"
  *
@@ -303,50 +298,39 @@ export type severity = "~effect/ErrorReporter/severity";
  * }
  * ```
  *
+ * @category annotations
  * @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.
+ * falling back to `"Info"` when the annotation is unset or invalid.
  *
+ * @category annotations
  * @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.
+ * String property key used to attach extra key/value metadata to an object
+ * 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
- *   }
- * }
- * ```
+ * include contextual information such as user IDs, request IDs, or other
+ * domain-specific debugging data.
  *
+ * @category annotations
  * @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.
+ * Runtime property key used to attach extra key/value metadata to an object
+ * 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.
+ * Set `error[ErrorReporter.attributes]` to a record of metadata that should be
+ * forwarded to reporters alongside the error.
+ *
+ * **Example** (Setting error attributes)
  *
- * @example
  * ```ts
  * import { Data, ErrorReporter } from "effect"
  *
@@ -359,16 +343,16 @@ export type attributes = "~effect/ErrorReporter/attributes";
  * }
  * ```
  *
+ * @category annotations
  * @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.
  *
+ * @category annotations
  * @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

@@ -1 +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,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;;;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,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAoC,CAAA;AAEpH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;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"}
+{"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"}

package/dist/ErrorReporter.js

@@ -4,8 +4,10 @@ import * as references from "./internal/references.js";
 import * as Layer from "./Layer.js";
 import * as LogLevel from "./LogLevel.js";
 /**
- * @since 4.0.0
+ * Runtime type identifier attached to `ErrorReporter` values.
+ *
  * @category Type Identifiers
+ * @since 4.0.0
  */
 export const TypeId = "~effect/ErrorReporter";
 /**
@@ -16,7 +18,8 @@ export const TypeId = "~effect/ErrorReporter";
  * and resolves the `ignore`, `severity`, and `attributes` annotations on
  * each error before invoking your callback.
  *
- * @example
+ * **Example** (Forwarding errors to the console)
+ *
  * ```ts
  * import { ErrorReporter } from "effect"
  *
@@ -28,8 +31,8 @@ export const TypeId = "~effect/ErrorReporter";
  * )
  * ```
  *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const make = report => {
   const reported = new WeakSet();
@@ -67,8 +70,8 @@ export const make = report => {
  * reference directly only when you need low-level control (e.g. reading the
  * current reporters or swapping them inside a `FiberRef`).
  *
+ * @category references
  * @since 4.0.0
- * @category References
  */
 export const CurrentErrorReporters = references.CurrentErrorReporters;
 /**
@@ -81,7 +84,8 @@ export const CurrentErrorReporters = references.CurrentErrorReporters;
  * reporters. Set `mergeWithExisting: true` to add them alongside existing
  * ones.
  *
- * @example
+ * **Example** (Providing error reporters)
+ *
  * ```ts
  * import { Effect, ErrorReporter } from "effect"
  *
@@ -111,8 +115,8 @@ export const CurrentErrorReporters = references.CurrentErrorReporters;
  * )
  * ```
  *
+ * @category layers
  * @since 4.0.0
- * @category Layers
  */
 export const layer = (reporters, options) => Layer.effect(CurrentErrorReporters, Effect.withFiber(Effect.fnUntraced(function* (fiber) {
   const currentReporters = new Set(options?.mergeWithExisting === true ? fiber.getRef(references.CurrentErrorReporters) : []);
@@ -128,7 +132,8 @@ export const layer = (reporters, options) => Layer.effect(CurrentErrorReporters,
  * This is useful when you want to report an error for observability without
  * actually failing the fiber.
  *
- * @example
+ * **Example** (Reporting a cause manually)
+ *
  * ```ts
  * import { Cause, Effect, ErrorReporter } from "effect"
  *
@@ -140,20 +145,23 @@ export const layer = (reporters, options) => Layer.effect(CurrentErrorReporters,
  * })
  * ```
  *
- * @since 4.0.0
  * @category Reporting
+ * @since 4.0.0
  */
 export const report = cause => Effect.withFiber(fiber => {
   effect.reportCauseUnsafe(fiber, cause);
   return Effect.void;
 });
 /**
- * Symbol key used to mark an error as unreportable.
+ * Runtime property key used to mark an object error as ignored by error
+ * reporting.
+ *
+ * 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.
  *
- * 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** (Marking errors as ignored)
  *
- * @example
  * ```ts
  * import { Data, ErrorReporter } from "effect"
  *
@@ -162,26 +170,26 @@ export const report = cause => Effect.withFiber(fiber => {
  * }
  * ```
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export const ignore = "~effect/ErrorReporter/ignore";
 /**
  * Returns `true` if the given value has the `ErrorReporter.ignore` annotation
  * set to `true`.
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export const isIgnored = u => typeof u === "object" && u !== null && ignore in u && u[ignore] === true;
 /**
- * Symbol key used to override the severity level of an error.
+ * Runtime property key used to override the severity level of an object 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"`.
+ * Set `error[ErrorReporter.severity]` to a valid `LogLevel.Severity` value.
+ * Missing or invalid values fall back to `"Info"`.
+ *
+ * **Example** (Setting error severity annotations)
  *
- * @example
  * ```ts
  * import { Data, ErrorReporter } from "effect"
  *
@@ -190,16 +198,16 @@ export const isIgnored = u => typeof u === "object" && u !== null && ignore in u
  * }
  * ```
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export const severity = "~effect/ErrorReporter/severity";
 /**
  * Reads the `ErrorReporter.severity` annotation from an error object,
- * falling back to `"Error"` when unset or invalid.
+ * falling back to `"Info"` when the annotation is unset or invalid.
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export const getSeverity = error => {
   if (severity in error && LogLevel.values.includes(error[severity])) {
@@ -208,13 +216,14 @@ export const getSeverity = error => {
   return "Info";
 };
 /**
- * Symbol key used to attach extra key/value metadata to an error report.
+ * Runtime property key used to attach extra key/value metadata to an object
+ * error report.
+ *
+ * Set `error[ErrorReporter.attributes]` to a record of metadata that should be
+ * forwarded to reporters alongside the error.
  *
- * 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** (Setting error attributes)
  *
- * @example
  * ```ts
  * import { Data, ErrorReporter } from "effect"
  *
@@ -227,16 +236,16 @@ export const getSeverity = error => {
  * }
  * ```
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export const attributes = "~effect/ErrorReporter/attributes";
 /**
  * Reads the `ErrorReporter.attributes` annotation from an error object,
  * returning an empty record when unset.
  *
+ * @category annotations
  * @since 4.0.0
- * @category Annotations
  */
 export const getAttributes = error => {
   return attributes in error ? error[attributes] : emptyAttributes;

package/dist/ErrorReporter.js.map

@@ -1 +1 @@
-{"version":3,"file":"ErrorReporter.js","names":["Effect","effect","references","Layer","LogLevel","TypeId","make","report","reported","WeakSet","options","has","cause","add","i","reasons","length","reason","_tag","original","error","defect","isObject","isIgnored","pretty","causePrettyError","annotations","severity","getSeverity","attributes","getAttributes","emptyAttributes","CurrentErrorReporters","layer","reporters","withFiber","fnUntraced","fiber","currentReporters","Set","mergeWithExisting","getRef","reporter","isEffect","reportCauseUnsafe","void","ignore","u","values","includes"],"sources":["../src/ErrorReporter.ts"],"sourcesContent":[null],"mappings":"AAoDA,OAAO,KAAKA,MAAM,MAAM,aAAa;AAErC,OAAO,KAAKC,MAAM,MAAM,sBAAsB;AAC9C,OAAO,KAAKC,UAAU,MAAM,0BAA0B;AACtD,OAAO,KAAKC,KAAK,MAAM,YAAY;AACnC,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAWzC;;;;AAIA,OAAO,MAAMC,MAAM,GAAW,uBAAuB;AAuBrD;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAMC,IAAI,GACfC,MAOU,IACO;EACjB,MAAMC,QAAQ,GAAG,IAAIC,OAAO,EAAiC;EAC7D,OAAO;IACL,CAACJ,MAAM,GAAGA,MAAM;IAChBE,MAAMA,CAACG,OAAO;MACZ,IAAIF,QAAQ,CAACG,GAAG,CAACD,OAAO,CAACE,KAAK,CAAC,EAAE;MACjCJ,QAAQ,CAACK,GAAG,CAACH,OAAO,CAACE,KAAK,CAAC;MAC3B,KAAK,IAAIE,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGJ,OAAO,CAACE,KAAK,CAACG,OAAO,CAACC,MAAM,EAAEF,CAAC,EAAE,EAAE;QACrD,MAAMG,MAAM,GAAGP,OAAO,CAACE,KAAK,CAACG,OAAO,CAACD,CAAC,CAAC;QACvC,IAAIG,MAAM,CAACC,IAAI,KAAK,WAAW,EAAE;QACjC,MAAMC,QAAQ,GAAGF,MAAM,CAACC,IAAI,KAAK,MAAM,GAAGD,MAAM,CAACG,KAAK,GAAGH,MAAM,CAACI,MAAM;QACtE,MAAMC,QAAQ,GAAG,OAAOH,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,KAAK,IAAI;QAClE,IAAIG,QAAQ,EAAE;UACZ,IAAId,QAAQ,CAACG,GAAG,CAACQ,QAAQ,CAAC,EAAE;UAC5BX,QAAQ,CAACK,GAAG,CAACM,QAAQ,CAAC;QACxB;QACA,IAAII,SAAS,CAACJ,QAAQ,CAAC,EAAE;QACzB,MAAMK,MAAM,GAAGvB,MAAM,CAACwB,gBAAgB,CAACN,QAAe,EAAEF,MAAM,CAACS,WAAW,CAAC;QAC3EnB,MAAM,CAAC;UACL,GAAGG,OAAO;UACVU,KAAK,EAAEI,MAAM;UACbG,QAAQ,EAAEL,QAAQ,GAAGM,WAAW,CAACT,QAAQ,CAAC,GAAG,MAAM;UACnDU,UAAU,EAAEP,QAAQ,GAAGQ,aAAa,CAACX,QAAQ,CAAC,GAAGY;SAClD,CAAC;MACJ;IACF;GACD;AACH,CAAC;AAED;;;;;;;;;;;AAWA,OAAO,MAAMC,qBAAqB,GAAkD9B,UAAU,CAAC8B,qBAAqB;AAEpH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,OAAO,MAAMC,KAAK,GAAGA,CAGnBC,SAAoB,EACpBxB,OAA0E,KAS1EP,KAAK,CAACF,MAAM,CACV+B,qBAAqB,EACrBhC,MAAM,CAACmC,SAAS,CAACnC,MAAM,CAACoC,UAAU,CAAC,WAAUC,KAAK;EAChD,MAAMC,gBAAgB,GAAG,IAAIC,GAAG,CAC9B7B,OAAO,EAAE8B,iBAAiB,KAAK,IAAI,GAAGH,KAAK,CAACI,MAAM,CAACvC,UAAU,CAAC8B,qBAAqB,CAAC,GAAG,EAAE,CAC1F;EACD,KAAK,MAAMU,QAAQ,IAAIR,SAAS,EAAE;IAChCI,gBAAgB,CAACzB,GAAG,CAACb,MAAM,CAAC2C,QAAQ,CAACD,QAAQ,CAAC,GAAG,OAAOA,QAAQ,GAAGA,QAAQ,CAAC;EAC9E;EACA,OAAOJ,gBAAgB;AACzB,CAAC,CAAC,CAAC,CACJ;AAEH;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAM/B,MAAM,GAAOK,KAAqB,IAC7CZ,MAAM,CAACmC,SAAS,CAAEE,KAAK,IAAI;EACzBpC,MAAM,CAAC2C,iBAAiB,CAACP,KAAK,EAAEzB,KAAK,CAAC;EACtC,OAAOZ,MAAM,CAAC6C,IAAI;AACpB,CAAC,CAAC;AA8CJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,MAAM,GAAW,8BAA8B;AAE5D;;;;;;;AAOA,OAAO,MAAMvB,SAAS,GAAIwB,CAAU,IAClC,OAAOA,CAAC,KAAK,QAAQ,IAAIA,CAAC,KAAK,IAAI,IAAID,MAAM,IAAIC,CAAC,IAAIA,CAAC,CAACD,MAAM,CAAC,KAAK,IAAI;AAuB1E;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMnB,QAAQ,GAAa,gCAAgC;AAElE;;;;;;;AAOA,OAAO,MAAMC,WAAW,GAAIR,KAAa,IAAc;EACrD,IAAIO,QAAQ,IAAIP,KAAK,IAAIhB,QAAQ,CAAC4C,MAAM,CAACC,QAAQ,CAAC7B,KAAK,CAACO,QAAQ,CAAa,CAAC,EAAE;IAC9E,OAAOP,KAAK,CAACO,QAAQ,CAAa;EACpC;EACA,OAAO,MAAM;AACf,CAAC;AA2BD;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAME,UAAU,GAAe,kCAAkC;AAExE;;;;;;;AAOA,OAAO,MAAMC,aAAa,GAAIV,KAAa,IAAqC;EAC9E,OAAOS,UAAU,IAAIT,KAAK,GAAGA,KAAK,CAACS,UAAU,CAAQ,GAAGE,eAAe;AACzE,CAAC;AAED,MAAMA,eAAe,GAAoC,EAAE","ignoreList":[]}
+{"version":3,"file":"ErrorReporter.js","names":["Effect","effect","references","Layer","LogLevel","TypeId","make","report","reported","WeakSet","options","has","cause","add","i","reasons","length","reason","_tag","original","error","defect","isObject","isIgnored","pretty","causePrettyError","annotations","severity","getSeverity","attributes","getAttributes","emptyAttributes","CurrentErrorReporters","layer","reporters","withFiber","fnUntraced","fiber","currentReporters","Set","mergeWithExisting","getRef","reporter","isEffect","reportCauseUnsafe","void","ignore","u","values","includes"],"sources":["../src/ErrorReporter.ts"],"sourcesContent":[null],"mappings":"AAqDA,OAAO,KAAKA,MAAM,MAAM,aAAa;AAErC,OAAO,KAAKC,MAAM,MAAM,sBAAsB;AAC9C,OAAO,KAAKC,UAAU,MAAM,0BAA0B;AACtD,OAAO,KAAKC,KAAK,MAAM,YAAY;AACnC,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAczC;;;;;;AAMA,OAAO,MAAMC,MAAM,GAAW,uBAAuB;AAuBrD;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,MAAMC,IAAI,GACfC,MAOU,IACO;EACjB,MAAMC,QAAQ,GAAG,IAAIC,OAAO,EAAiC;EAC7D,OAAO;IACL,CAACJ,MAAM,GAAGA,MAAM;IAChBE,MAAMA,CAACG,OAAO;MACZ,IAAIF,QAAQ,CAACG,GAAG,CAACD,OAAO,CAACE,KAAK,CAAC,EAAE;MACjCJ,QAAQ,CAACK,GAAG,CAACH,OAAO,CAACE,KAAK,CAAC;MAC3B,KAAK,IAAIE,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGJ,OAAO,CAACE,KAAK,CAACG,OAAO,CAACC,MAAM,EAAEF,CAAC,EAAE,EAAE;QACrD,MAAMG,MAAM,GAAGP,OAAO,CAACE,KAAK,CAACG,OAAO,CAACD,CAAC,CAAC;QACvC,IAAIG,MAAM,CAACC,IAAI,KAAK,WAAW,EAAE;QACjC,MAAMC,QAAQ,GAAGF,MAAM,CAACC,IAAI,KAAK,MAAM,GAAGD,MAAM,CAACG,KAAK,GAAGH,MAAM,CAACI,MAAM;QACtE,MAAMC,QAAQ,GAAG,OAAOH,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,KAAK,IAAI;QAClE,IAAIG,QAAQ,EAAE;UACZ,IAAId,QAAQ,CAACG,GAAG,CAACQ,QAAQ,CAAC,EAAE;UAC5BX,QAAQ,CAACK,GAAG,CAACM,QAAQ,CAAC;QACxB;QACA,IAAII,SAAS,CAACJ,QAAQ,CAAC,EAAE;QACzB,MAAMK,MAAM,GAAGvB,MAAM,CAACwB,gBAAgB,CAACN,QAAe,EAAEF,MAAM,CAACS,WAAW,CAAC;QAC3EnB,MAAM,CAAC;UACL,GAAGG,OAAO;UACVU,KAAK,EAAEI,MAAM;UACbG,QAAQ,EAAEL,QAAQ,GAAGM,WAAW,CAACT,QAAQ,CAAC,GAAG,MAAM;UACnDU,UAAU,EAAEP,QAAQ,GAAGQ,aAAa,CAACX,QAAQ,CAAC,GAAGY;SAClD,CAAC;MACJ;IACF;GACD;AACH,CAAC;AAED;;;;;;;;;;;AAWA,OAAO,MAAMC,qBAAqB,GAAkD9B,UAAU,CAAC8B,qBAAqB;AAEpH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,OAAO,MAAMC,KAAK,GAAGA,CAGnBC,SAAoB,EACpBxB,OAA0E,KAS1EP,KAAK,CAACF,MAAM,CACV+B,qBAAqB,EACrBhC,MAAM,CAACmC,SAAS,CAACnC,MAAM,CAACoC,UAAU,CAAC,WAAUC,KAAK;EAChD,MAAMC,gBAAgB,GAAG,IAAIC,GAAG,CAC9B7B,OAAO,EAAE8B,iBAAiB,KAAK,IAAI,GAAGH,KAAK,CAACI,MAAM,CAACvC,UAAU,CAAC8B,qBAAqB,CAAC,GAAG,EAAE,CAC1F;EACD,KAAK,MAAMU,QAAQ,IAAIR,SAAS,EAAE;IAChCI,gBAAgB,CAACzB,GAAG,CAACb,MAAM,CAAC2C,QAAQ,CAACD,QAAQ,CAAC,GAAG,OAAOA,QAAQ,GAAGA,QAAQ,CAAC;EAC9E;EACA,OAAOJ,gBAAgB;AACzB,CAAC,CAAC,CAAC,CACJ;AAEH;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAM/B,MAAM,GAAOK,KAAqB,IAC7CZ,MAAM,CAACmC,SAAS,CAAEE,KAAK,IAAI;EACzBpC,MAAM,CAAC2C,iBAAiB,CAACP,KAAK,EAAEzB,KAAK,CAAC;EACtC,OAAOZ,MAAM,CAAC6C,IAAI;AACpB,CAAC,CAAC;AAuCJ;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,MAAMC,MAAM,GAAW,8BAA8B;AAE5D;;;;;;;AAOA,OAAO,MAAMvB,SAAS,GAAIwB,CAAU,IAClC,OAAOA,CAAC,KAAK,QAAQ,IAAIA,CAAC,KAAK,IAAI,IAAID,MAAM,IAAIC,CAAC,IAAIA,CAAC,CAACD,MAAM,CAAC,KAAK,IAAI;AAa1E;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMnB,QAAQ,GAAa,gCAAgC;AAElE;;;;;;;AAOA,OAAO,MAAMC,WAAW,GAAIR,KAAa,IAAc;EACrD,IAAIO,QAAQ,IAAIP,KAAK,IAAIhB,QAAQ,CAAC4C,MAAM,CAACC,QAAQ,CAAC7B,KAAK,CAACO,QAAQ,CAAa,CAAC,EAAE;IAC9E,OAAOP,KAAK,CAACO,QAAQ,CAAa;EACpC;EACA,OAAO,MAAM;AACf,CAAC;AAeD;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,MAAME,UAAU,GAAe,kCAAkC;AAExE;;;;;;;AAOA,OAAO,MAAMC,aAAa,GAAIV,KAAa,IAAqC;EAC9E,OAAOS,UAAU,IAAIT,KAAK,GAAGA,KAAK,CAACS,UAAU,CAAQ,GAAGE,eAAe;AACzE,CAAC;AAED,MAAMA,eAAe,GAAoC,EAAE","ignoreList":[]}