effect 4.0.0-beta.70 → 4.0.0-beta.72

package/dist/ErrorReporter.d.ts

@@ -61,14 +61,24 @@ import type * as Scope from "./Scope.ts";
  * String literal type used as the runtime type identifier for
  * `ErrorReporter` values.
  *
- * @category Type Identifiers
+ * **When to use**
+ *
+ * Use to refer to the runtime type identifier type in low-level integrations.
+ *
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~effect/ErrorReporter";
 /**
  * Runtime type identifier attached to `ErrorReporter` values.
  *
- * @category Type Identifiers
+ * **Details**
+ *
+ * This marker is part of the runtime representation of `ErrorReporter`
+ * implementations. Most code should create reporters with `make` and register
+ * them with `layer`.
+ *
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
@@ -76,6 +86,11 @@ export declare const TypeId: TypeId;
  * An `ErrorReporter` receives reported failures and forwards them to an
  * external system such as a logging service or error tracker.
  *
+ * **When to use**
+ *
+ * Use as the interface for custom reporters that forward reported Effect
+ * failures to logging, monitoring, or error-tracking systems.
+ *
  * **Details**
  *
  * Reporting is triggered by `Effect.withErrorReporting`,
@@ -83,6 +98,11 @@ export declare const TypeId: TypeId;
  * modules. Use {@link make} to create a reporter; it handles deduplication
  * and per-error annotation extraction automatically.
  *
+ * @see {@link make} for creating an `ErrorReporter` from a callback
+ * @see {@link layer} for registering reporters in the environment
+ * @see {@link report} for manually reporting a `Cause`
+ * @see {@link Effect.withErrorReporting} for reporting failures from an effect
+ *
  * @category models
  * @since 4.0.0
  */
@@ -97,6 +117,11 @@ export interface ErrorReporter {
 /**
  * Creates an `ErrorReporter` from a callback.
  *
+ * **When to use**
+ *
+ * Use to define how reported failures are forwarded to a logging, monitoring,
+ * or error-tracking backend.
+ *
  * **Details**
  *
  * The returned reporter automatically deduplicates causes and individual
@@ -117,6 +142,9 @@ export interface ErrorReporter {
  * )
  * ```
  *
+ * @see {@link layer} for registering reporters in the environment
+ * @see {@link report} for manually reporting a `Cause`
+ *
  * @category constructors
  * @since 4.0.0
  */
@@ -129,14 +157,13 @@ export declare const make: (report: (options: {
     readonly timestamp: bigint;
 }) => void) => ErrorReporter;
 /**
- * A `Context.Reference` holding the set of active `ErrorReporter`s for the
+ * Context reference that holds the set of active error reporters 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`).
+ * Use when low-level code needs to read or replace the current set of reporters
+ * directly.
  *
  * @category references
  * @since 4.0.0
@@ -145,6 +172,11 @@ export declare const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorR
 /**
  * Creates a `Layer` that registers one or more `ErrorReporter`s.
  *
+ * **When to use**
+ *
+ * Use to provide one or more error reporters to effects that perform error
+ * reporting.
+ *
  * **Details**
  *
  * Reporters can be plain `ErrorReporter` values or effectful
@@ -183,6 +215,9 @@ export declare const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorR
  * )
  * ```
  *
+ * @see {@link make} for creating an `ErrorReporter` from a callback
+ * @see {@link CurrentErrorReporters} for low-level access to the current reporters
+ *
  * @category layers
  * @since 4.0.0
  */
@@ -190,13 +225,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 reports a `Cause` to all registered `ErrorReporter`s on the
- * current fiber.
+ * Runs all registered error reporters on the current fiber for a `Cause`.
  *
  * **When to use**
  *
- * This is useful when you want to report an error for observability without
- * actually failing the fiber.
+ * Use to report a failure for observability without failing the current fiber.
  *
  * **Example** (Reporting a cause manually)
  *
@@ -218,6 +251,11 @@ export declare const report: <E>(cause: Cause.Cause<E>) => Effect.Effect<void>;
 /**
  * Interface that object errors can implement to control reporting behavior.
  *
+ * **When to use**
+ *
+ * Use as the annotation contract for object errors that customize how error
+ * reporting handles them.
+ *
  * **Details**
  *
  * All three annotation properties are optional: `[ErrorReporter.ignore]`
@@ -227,6 +265,11 @@ export declare const report: <E>(cause: Cause.Cause<E>) => Effect.Effect<void>;
  * augmented with `Reportable`, so these properties are available on `Error`
  * instances at the type level.
  *
+ * @see {@link ignore} for the runtime annotation key that suppresses reports
+ * @see {@link severity} for the runtime annotation key that overrides severity
+ * @see {@link attributes} for the runtime annotation key that attaches reporter
+ * metadata
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -240,9 +283,14 @@ declare global {
     }
 }
 /**
- * String property key used to mark an object error as ignored by error
+ * Defines the string property key used to mark an object error as ignored by error
  * reporting.
  *
+ * **When to use**
+ *
+ * Use to type the property key that suppresses reporting for expected object
+ * errors.
+ *
  * **Details**
  *
  * Set this property to `true` on an error class or object error to prevent it
@@ -254,9 +302,14 @@ declare global {
  */
 export type ignore = "~effect/ErrorReporter/ignore";
 /**
- * Runtime property key used to mark an object error as ignored by error
+ * Defines the runtime property key used to mark an object error as ignored by error
  * reporting.
  *
+ * **When to use**
+ *
+ * Use to suppress reporting for expected object errors, such as HTTP 404
+ * responses.
+ *
  * **Details**
  *
  * Set `error[ErrorReporter.ignore]` to `true` to prevent the error from being
@@ -273,6 +326,10 @@ export type ignore = "~effect/ErrorReporter/ignore";
  * }
  * ```
  *
+ * @see {@link isIgnored} for checking whether a value carries this annotation
+ * @see {@link Reportable} for the annotation contract recognized on object
+ * errors
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -281,12 +338,24 @@ export declare const ignore: ignore;
  * Returns `true` if the given value has the `ErrorReporter.ignore` annotation
  * set to `true`.
  *
+ * **When to use**
+ *
+ * Use to check whether an error value is annotated to be skipped before
+ * forwarding it to error reporting code.
+ *
+ * @see {@link ignore} for the annotation key this predicate reads
+ *
  * @category annotations
  * @since 4.0.0
  */
 export declare const isIgnored: (u: unknown) => boolean;
 /**
- * String property key used to override the severity level of an object error.
+ * Defines the string property key used to override the severity level of an object error.
+ *
+ * **When to use**
+ *
+ * Use to type the property key that overrides the reporting severity for object
+ * errors.
  *
  * **Details**
  *
@@ -298,7 +367,12 @@ export declare const isIgnored: (u: unknown) => boolean;
  */
 export type severity = "~effect/ErrorReporter/severity";
 /**
- * Runtime property key used to override the severity level of an object error.
+ * Defines the runtime property key used to override the severity level of an object error.
+ *
+ * **When to use**
+ *
+ * Use to annotate object errors with the severity reporter callbacks should
+ * receive.
  *
  * **Details**
  *
@@ -315,6 +389,10 @@ export type severity = "~effect/ErrorReporter/severity";
  * }
  * ```
  *
+ * @see {@link getSeverity} for reading the severity stored under this key
+ * @see {@link Reportable} for the annotation contract recognized on object
+ * errors
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -323,14 +401,26 @@ export declare const severity: severity;
  * Reads the `ErrorReporter.severity` annotation from an error object,
  * falling back to `"Info"` when the annotation is unset or invalid.
  *
+ * **When to use**
+ *
+ * Use to inspect the severity that reporter callbacks will receive for an
+ * object error.
+ *
+ * @see {@link severity} for the annotation key used to override severity
+ * @see {@link Reportable} for the annotation properties recognized on object errors
+ *
  * @category annotations
  * @since 4.0.0
  */
 export declare const getSeverity: (error: object) => Severity;
 /**
- * String property key used to attach extra key/value metadata to an object
+ * Defines the string property key used to attach extra key/value metadata to an object
  * error report.
  *
+ * **When to use**
+ *
+ * Use to type the property key that attaches metadata to object error reports.
+ *
  * **Details**
  *
  * Reporters receive these attributes alongside the error, making it easy to
@@ -342,9 +432,14 @@ export declare const getSeverity: (error: object) => Severity;
  */
 export type attributes = "~effect/ErrorReporter/attributes";
 /**
- * Runtime property key used to attach extra key/value metadata to an object
+ * Defines the runtime property key used to attach extra key/value metadata to an object
  * error report.
  *
+ * **When to use**
+ *
+ * Use to attach domain metadata to object errors so reporter callbacks receive
+ * it with the reported failure.
+ *
  * **Details**
  *
  * Set `error[ErrorReporter.attributes]` to a record of metadata that should be
@@ -364,6 +459,12 @@ export type attributes = "~effect/ErrorReporter/attributes";
  * }
  * ```
  *
+ * @see {@link ignore} for suppressing reports for expected object errors
+ * @see {@link severity} for overriding reporter severity
+ * @see {@link getAttributes} for reading the metadata stored under this key
+ * @see {@link Reportable} for the annotation contract recognized on object
+ * errors
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -372,6 +473,24 @@ export declare const attributes: attributes;
  * Reads the `ErrorReporter.attributes` annotation from an error object,
  * returning an empty record when unset.
  *
+ * **When to use**
+ *
+ * Use to inspect the attributes that reporter callbacks will receive for an
+ * object error.
+ *
+ * **Details**
+ *
+ * Returns the value stored under `ErrorReporter.attributes`, or the module's
+ * shared empty record when the annotation is absent.
+ *
+ * **Gotchas**
+ *
+ * The annotation value is returned as-is; this helper does not validate or
+ * clone it.
+ *
+ * @see {@link attributes} for the annotation key used to attach metadata
+ * @see {@link Reportable} for the annotation properties recognized on object errors
+ *
  * @category annotations
  * @since 4.0.0
  */

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;;;;;;;;;;;;;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"}
+{"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;;;;;;;;;;GAUG;AACH,MAAM,MAAM,MAAM,GAAG,uBAAuB,CAAA;AAE5C;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,EAAE,MAAgC,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;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;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,EAAE,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAoC,CAAA;AAEpH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;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;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,MAAM,EAAE,MAAuC,CAAA;AAE5D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,OAAO,KAAG,OACmC,CAAA;AAE1E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,QAAQ,GAAG,gCAAgC,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,QAAQ,EAAE,QAA2C,CAAA;AAElE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,QAK3C,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,UAAU,GAAG,kCAAkC,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,UAAU,EAAE,UAA+C,CAAA;AAExE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAE3E,CAAA"}

package/dist/ErrorReporter.js

@@ -6,13 +6,24 @@ import * as LogLevel from "./LogLevel.js";
 /**
  * Runtime type identifier attached to `ErrorReporter` values.
  *
- * @category Type Identifiers
+ * **Details**
+ *
+ * This marker is part of the runtime representation of `ErrorReporter`
+ * implementations. Most code should create reporters with `make` and register
+ * them with `layer`.
+ *
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~effect/ErrorReporter";
 /**
  * Creates an `ErrorReporter` from a callback.
  *
+ * **When to use**
+ *
+ * Use to define how reported failures are forwarded to a logging, monitoring,
+ * or error-tracking backend.
+ *
  * **Details**
  *
  * The returned reporter automatically deduplicates causes and individual
@@ -33,6 +44,9 @@ export const TypeId = "~effect/ErrorReporter";
  * )
  * ```
  *
+ * @see {@link layer} for registering reporters in the environment
+ * @see {@link report} for manually reporting a `Cause`
+ *
  * @category constructors
  * @since 4.0.0
  */
@@ -65,14 +79,13 @@ export const make = report => {
   };
 };
 /**
- * A `Context.Reference` holding the set of active `ErrorReporter`s for the
+ * Context reference that holds the set of active error reporters 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`).
+ * Use when low-level code needs to read or replace the current set of reporters
+ * directly.
  *
  * @category references
  * @since 4.0.0
@@ -81,6 +94,11 @@ export const CurrentErrorReporters = references.CurrentErrorReporters;
 /**
  * Creates a `Layer` that registers one or more `ErrorReporter`s.
  *
+ * **When to use**
+ *
+ * Use to provide one or more error reporters to effects that perform error
+ * reporting.
+ *
  * **Details**
  *
  * Reporters can be plain `ErrorReporter` values or effectful
@@ -119,6 +137,9 @@ export const CurrentErrorReporters = references.CurrentErrorReporters;
  * )
  * ```
  *
+ * @see {@link make} for creating an `ErrorReporter` from a callback
+ * @see {@link CurrentErrorReporters} for low-level access to the current reporters
+ *
  * @category layers
  * @since 4.0.0
  */
@@ -130,13 +151,11 @@ export const layer = (reporters, options) => Layer.effect(CurrentErrorReporters,
   return currentReporters;
 })));
 /**
- * Manually reports a `Cause` to all registered `ErrorReporter`s on the
- * current fiber.
+ * Runs all registered error reporters on the current fiber for a `Cause`.
  *
  * **When to use**
  *
- * This is useful when you want to report an error for observability without
- * actually failing the fiber.
+ * Use to report a failure for observability without failing the current fiber.
  *
  * **Example** (Reporting a cause manually)
  *
@@ -159,9 +178,14 @@ export const report = cause => Effect.withFiber(fiber => {
   return Effect.void;
 });
 /**
- * Runtime property key used to mark an object error as ignored by error
+ * Defines the runtime property key used to mark an object error as ignored by error
  * reporting.
  *
+ * **When to use**
+ *
+ * Use to suppress reporting for expected object errors, such as HTTP 404
+ * responses.
+ *
  * **Details**
  *
  * Set `error[ErrorReporter.ignore]` to `true` to prevent the error from being
@@ -178,6 +202,10 @@ export const report = cause => Effect.withFiber(fiber => {
  * }
  * ```
  *
+ * @see {@link isIgnored} for checking whether a value carries this annotation
+ * @see {@link Reportable} for the annotation contract recognized on object
+ * errors
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -186,12 +214,24 @@ export const ignore = "~effect/ErrorReporter/ignore";
  * Returns `true` if the given value has the `ErrorReporter.ignore` annotation
  * set to `true`.
  *
+ * **When to use**
+ *
+ * Use to check whether an error value is annotated to be skipped before
+ * forwarding it to error reporting code.
+ *
+ * @see {@link ignore} for the annotation key this predicate reads
+ *
  * @category annotations
  * @since 4.0.0
  */
 export const isIgnored = u => typeof u === "object" && u !== null && ignore in u && u[ignore] === true;
 /**
- * Runtime property key used to override the severity level of an object error.
+ * Defines the runtime property key used to override the severity level of an object error.
+ *
+ * **When to use**
+ *
+ * Use to annotate object errors with the severity reporter callbacks should
+ * receive.
  *
  * **Details**
  *
@@ -208,6 +248,10 @@ export const isIgnored = u => typeof u === "object" && u !== null && ignore in u
  * }
  * ```
  *
+ * @see {@link getSeverity} for reading the severity stored under this key
+ * @see {@link Reportable} for the annotation contract recognized on object
+ * errors
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -216,6 +260,14 @@ export const severity = "~effect/ErrorReporter/severity";
  * Reads the `ErrorReporter.severity` annotation from an error object,
  * falling back to `"Info"` when the annotation is unset or invalid.
  *
+ * **When to use**
+ *
+ * Use to inspect the severity that reporter callbacks will receive for an
+ * object error.
+ *
+ * @see {@link severity} for the annotation key used to override severity
+ * @see {@link Reportable} for the annotation properties recognized on object errors
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -226,9 +278,14 @@ export const getSeverity = error => {
   return "Info";
 };
 /**
- * Runtime property key used to attach extra key/value metadata to an object
+ * Defines the runtime property key used to attach extra key/value metadata to an object
  * error report.
  *
+ * **When to use**
+ *
+ * Use to attach domain metadata to object errors so reporter callbacks receive
+ * it with the reported failure.
+ *
  * **Details**
  *
  * Set `error[ErrorReporter.attributes]` to a record of metadata that should be
@@ -248,6 +305,12 @@ export const getSeverity = error => {
  * }
  * ```
  *
+ * @see {@link ignore} for suppressing reports for expected object errors
+ * @see {@link severity} for overriding reporter severity
+ * @see {@link getAttributes} for reading the metadata stored under this key
+ * @see {@link Reportable} for the annotation contract recognized on object
+ * errors
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -256,6 +319,24 @@ export const attributes = "~effect/ErrorReporter/attributes";
  * Reads the `ErrorReporter.attributes` annotation from an error object,
  * returning an empty record when unset.
  *
+ * **When to use**
+ *
+ * Use to inspect the attributes that reporter callbacks will receive for an
+ * object error.
+ *
+ * **Details**
+ *
+ * Returns the value stored under `ErrorReporter.attributes`, or the module's
+ * shared empty record when the annotation is absent.
+ *
+ * **Gotchas**
+ *
+ * The annotation value is returned as-is; this helper does not validate or
+ * clone it.
+ *
+ * @see {@link attributes} for the annotation key used to attach metadata
+ * @see {@link Reportable} for the annotation properties recognized on object errors
+ *
  * @category annotations
  * @since 4.0.0
  */

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":"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;AAyBrD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,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;;;;;;;;;;;;;AAaA,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;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,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;AA0CJ;;;;;;;;;;;;;;;;;;;;;;;AAuBA,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;AAe1E;;;;;;;;;;;;;;;;;;;;;AAqBA,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;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,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;AAkBzC;;;;;;;;;;;;AAYA,OAAO,MAAMC,MAAM,GAAW,uBAAuB;AAmCrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,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;;;;;;;;;;;;AAYA,OAAO,MAAMC,qBAAqB,GAAkD9B,UAAU,CAAC8B,qBAAqB;AAEpH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDA,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;AAyDJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,OAAO,MAAMC,MAAM,GAAW,8BAA8B;AAE5D;;;;;;;;;;;;;;AAcA,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;AAoB1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,OAAO,MAAMnB,QAAQ,GAAa,gCAAgC;AAElE;;;;;;;;;;;;;;;AAeA,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;AAqBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,OAAO,MAAME,UAAU,GAAe,kCAAkC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,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":[]}