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

package/dist/Cause.d.ts

@@ -32,7 +32,7 @@
  *
  * ## Gotchas
  *
- * - `findError`/`findDefect` return `Filter.fail` (not `Option.none`) when no match is
+ * - `findError`/`findDefect` return `Result.fail` (not `Option.none`) when no match is
  *   found. Use {@link findErrorOption} if you need an `Option`.
  * - `squash` picks the first `Fail` error, then the first `Die` defect, then falls back
  *   to a generic "interrupted" / "empty" error. It is lossy — use `prettyErrors` or
@@ -59,22 +59,20 @@
  *   const errors = cause.reasons
  *     .filter(Cause.isFailReason)
  *     .map((r) => r.error)
+ *     .sort()
  *
  *   const defects = cause.reasons
  *     .filter(Cause.isDieReason)
- *     .map((r) => r.defect)
+ *     .map((r) => String(r.defect))
+ *     .sort()
  *
- *   console.log(errors)  // ["err1", "err2"]  (order may vary)
- *   console.log(defects) // ["defect"]
+ *   console.log(errors.join(",")) // "err1,err2"
+ *   console.log(defects.join(",")) // "defect"
  * })
  *
  * Effect.runPromise(program)
  * ```
  *
- * @see {@link Cause} — the core interface
- * @see {@link Reason} — the union of failure kinds
- * @see {@link pretty} — human-readable rendering
- *
  * @since 2.0.0
  */
 import * as Context from "./Context.ts";
@@ -90,20 +88,25 @@ import type * as Types from "./Types.ts";
 /**
  * Unique brand for `Cause` values, used for runtime type checks via {@link isCause}.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: "~effect/Cause";
 /**
  * Unique brand for `Reason` values, used for runtime type checks via {@link isReason}.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const ReasonTypeId: "~effect/Cause/Reason";
 /**
  * A structured representation of how an Effect failed.
  *
+ * **When to use**
+ *
+ * Use to preserve the full structured failure information for an effect instead
+ * of collapsing it to a single error value.
+ *
  * **Details**
  *
  * Access the individual failure entries through the `reasons` array, then
@@ -129,8 +132,6 @@ export declare const ReasonTypeId: "~effect/Cause/Reason";
  * console.log(Cause.isFailReason(cause.reasons[0])) // true
  * ```
  *
- * @see {@link Reason} — the union type stored in `reasons`
- *
  * @category models
  * @since 2.0.0
  */
@@ -139,7 +140,7 @@ export interface Cause<out E> extends Pipeable, Inspectable, Equal {
     readonly reasons: ReadonlyArray<Reason<E>>;
 }
 /**
- * Tests if an arbitrary value is a {@link Cause}.
+ * Checks whether an arbitrary value is a `Cause`.
  *
  * **Example** (runtime type check)
  *
@@ -155,7 +156,7 @@ export interface Cause<out E> extends Pipeable, Inspectable, Equal {
  */
 export declare const isCause: (self: unknown) => self is Cause<unknown>;
 /**
- * Tests if an arbitrary value is a {@link Reason} (`Fail`, `Die`, or `Interrupt`).
+ * Checks whether an arbitrary value is a `Reason` (`Fail`, `Die`, or `Interrupt`).
  *
  * **Example** (runtime type check)
  *
@@ -172,7 +173,7 @@ export declare const isCause: (self: unknown) => self is Cause<unknown>;
  */
 export declare const isReason: (self: unknown) => self is Reason<unknown>;
 /**
- * A single entry inside a {@link Cause}'s `reasons` array.
+ * A single entry inside a `Cause`'s `reasons` array.
  *
  * **Details**
  *
@@ -197,20 +198,17 @@ export declare const isReason: (self: unknown) => self is Reason<unknown>;
  * }
  * ```
  *
- * @see {@link Fail} — typed error reason
- * @see {@link Die} — untyped defect reason
- * @see {@link Interrupt} — interruption reason
- *
  * @category models
  * @since 4.0.0
  */
 export type Reason<E> = Fail<E> | Die | Interrupt;
 /**
- * Narrows a {@link Reason} to {@link Fail}.
+ * Narrows a `Reason` to `Fail`.
  *
  * **When to use**
  *
- * Useful as a predicate for `Array.filter` when iterating over `cause.reasons`.
+ * Use as a predicate for `Array.filter` to pick out typed `Fail` reasons when
+ * iterating over `cause.reasons`.
  *
  * **Example** (filtering fail reasons)
  *
@@ -230,11 +228,12 @@ export type Reason<E> = Fail<E> | Die | Interrupt;
  */
 export declare const isFailReason: <E>(self: Reason<E>) => self is Fail<E>;
 /**
- * Narrows a {@link Reason} to {@link Die}.
+ * Narrows a `Reason` to `Die`.
  *
  * **When to use**
  *
- * Useful as a predicate for `Array.filter` when iterating over `cause.reasons`.
+ * Use as a predicate for `Array.filter` to pick out `Die` (defect) reasons when
+ * iterating over `cause.reasons`.
  *
  * **Example** (filtering die reasons)
  *
@@ -254,11 +253,12 @@ export declare const isFailReason: <E>(self: Reason<E>) => self is Fail<E>;
  */
 export declare const isDieReason: <E>(self: Reason<E>) => self is Die;
 /**
- * Narrows a {@link Reason} to {@link Interrupt}.
+ * Narrows a `Reason` to `Interrupt`.
  *
  * **When to use**
  *
- * Useful as a predicate for `Array.filter` when iterating over `cause.reasons`.
+ * Use as a predicate for `Array.filter` to pick out `Interrupt` reasons when
+ * iterating over `cause.reasons`.
  *
  * **Example** (filtering interrupt reasons)
  *
@@ -278,7 +278,7 @@ export declare const isDieReason: <E>(self: Reason<E>) => self is Die;
  */
 export declare const isInterruptReason: <E>(self: Reason<E>) => self is Interrupt;
 /**
- * Companion namespace for the {@link Cause} interface.
+ * Companion namespace for the `Cause` interface.
  *
  * @since 2.0.0
  */
@@ -300,8 +300,7 @@ export declare namespace Cause {
      */
     type Error<T> = T extends Cause<infer E> ? E : never;
     /**
-     * Base interface shared by all reason types ({@link Fail}, {@link Die},
-     * {@link Interrupt}).
+     * Base interface shared by all reason types (`Fail`, `Die`, `Interrupt`).
      *
      * **Details**
      *
@@ -323,7 +322,7 @@ export declare namespace Cause {
     }
 }
 /**
- * Companion namespace for the {@link Reason} type.
+ * Companion namespace for the `Reason` type.
  *
  * @since 4.0.0
  */
@@ -348,10 +347,15 @@ export declare namespace Reason {
 /**
  * An untyped defect — typically a programming error or an uncaught exception.
  *
+ * **When to use**
+ *
+ * Use when inspecting `Cause` reasons that represent defects instead of typed
+ * failures or interruptions.
+ *
  * **Details**
  *
  * The `defect` property is `unknown` because defects are not part of the
- * typed error channel. Use {@link isDieReason} to narrow a {@link Reason}
+ * typed error channel. Use {@link isDieReason} to narrow a `Reason`
  * to this type.
  *
  * **Example** (accessing the defect)
@@ -359,15 +363,15 @@ export declare namespace Reason {
  * ```ts
  * import { Cause } from "effect"
  *
- * const cause = Cause.die(new Error("Unexpected"))
+ * const cause = Cause.die("Unexpected")
  * const reason = cause.reasons[0]
  * if (Cause.isDieReason(reason)) {
- *   console.log(reason.defect) // Error: Unexpected
+ *   console.log(reason.defect) // "Unexpected"
  * }
  * ```
  *
- * @see {@link die} — create a `Cause` containing a single `Die`
- * @see {@link isDieReason} — type guard
+ * @see {@link die} for constructing a cause with a single `Die` reason
+ * @see {@link isDieReason} for narrowing a `Reason` to `Die`
  *
  * @category models
  * @since 2.0.0
@@ -378,10 +382,15 @@ export interface Die extends Cause.ReasonProto<"Die"> {
 /**
  * A typed, expected error produced by `Effect.fail`.
  *
+ * **When to use**
+ *
+ * Use when inspecting `Cause` reasons that represent expected failures from the
+ * typed error channel.
+ *
  * **Details**
  *
  * The `error` property carries the typed value `E`. Use {@link isFailReason}
- * to narrow a {@link Reason} to this type.
+ * to narrow a `Reason` to this type.
  *
  * **Example** (accessing the error)
  *
@@ -395,8 +404,8 @@ export interface Die extends Cause.ReasonProto<"Die"> {
  * }
  * ```
  *
- * @see {@link fail} — create a `Cause` containing a single `Fail`
- * @see {@link isFailReason} — type guard
+ * @see {@link fail} for constructing a cause with a single `Fail` reason
+ * @see {@link isFailReason} for narrowing a `Reason` to `Fail`
  *
  * @category models
  * @since 2.0.0
@@ -410,7 +419,7 @@ export interface Fail<out E> extends Cause.ReasonProto<"Fail"> {
  *
  * **Details**
  *
- * Use {@link isInterruptReason} to narrow a {@link Reason} to this type.
+ * Use {@link isInterruptReason} to narrow a `Reason` to this type.
  *
  * **Example** (accessing the fiber ID)
  *
@@ -424,9 +433,6 @@ export interface Fail<out E> extends Cause.ReasonProto<"Fail"> {
  * }
  * ```
  *
- * @see {@link interrupt} — create a `Cause` containing a single `Interrupt`
- * @see {@link isInterruptReason} — type guard
- *
  * @category models
  * @since 2.0.0
  */
@@ -434,18 +440,23 @@ export interface Interrupt extends Cause.ReasonProto<"Interrupt"> {
     readonly fiberId: number | undefined;
 }
 /**
- * Creates a {@link Cause} from an array of {@link Reason} values.
+ * Creates a `Cause` from an array of `Reason` values.
  *
  * **When to use**
  *
- * Use this when you already have individual reasons (e.g. from filtering or
+ * Use when you already have individual reasons (e.g. from filtering or
  * transforming another cause's `reasons` array) and need to wrap them back
  * into a `Cause`.
  *
  * **Details**
  *
- * - Returns a new `Cause`; does not mutate the input array.
- * - An empty array produces a cause equivalent to {@link empty}.
+ * - Returns a new `Cause`.
+ * - An empty array produces a cause equivalent to `empty`.
+ *
+ * **Gotchas**
+ *
+ * The `reasons` array is stored as provided. Treat the array as immutable
+ * after passing it to this function.
  *
  * **Example** (building a cause from reasons)
  *
@@ -467,23 +478,43 @@ export interface Interrupt extends Cause.ReasonProto<"Interrupt"> {
  */
 export declare const fromReasons: <E>(reasons: ReadonlyArray<Reason<E>>) => Cause<E>;
 /**
- * A {@link Cause} with an empty `reasons` array.
+ * Represents a `Cause` with an empty `reasons` array.
+ *
+ * **When to use**
+ *
+ * Use to represent the absence of failure when constructing or combining
+ * causes.
  *
  * **Details**
  *
  * Represents the absence of failure. Combining any cause with `empty` via
  * {@link combine} returns the original cause unchanged.
  *
- * @see {@link combine}
+ * **Example** (combining with the empty cause)
+ *
+ * ```ts
+ * import { Cause } from "effect"
+ *
+ * const cause = Cause.combine(Cause.empty, Cause.fail("boom"))
+ *
+ * console.log(cause.reasons.length) // 1
+ * console.log(Cause.hasFails(cause)) // true
+ * ```
+ *
+ * @see {@link combine} for merging causes where `empty` acts as the identity
  *
  * @category constructors
  * @since 2.0.0
  */
 export declare const empty: Cause<never>;
 /**
- * Creates a {@link Cause} containing a single {@link Fail} reason with the
+ * Creates a `Cause` containing a single `Fail` reason with the
  * given typed error.
  *
+ * **When to use**
+ *
+ * Use to construct a cause from an expected typed error.
+ *
  * **Example** (creating a fail cause)
  *
  * ```ts
@@ -502,15 +533,19 @@ export declare const empty: Cause<never>;
  */
 export declare const fail: <E>(error: E) => Cause<E>;
 /**
- * Creates a {@link Cause} containing a single {@link Die} reason with the
+ * Creates a `Cause` containing a single `Die` reason with the
  * given defect.
  *
+ * **When to use**
+ *
+ * Use to construct a cause from an untyped defect or unexpected thrown value.
+ *
  * **Example** (creating a die cause)
  *
  * ```ts
  * import { Cause } from "effect"
  *
- * const cause = Cause.die(new Error("Unexpected"))
+ * const cause = Cause.die("Unexpected")
  * console.log(cause.reasons.length) // 1
  * console.log(Cause.isDieReason(cause.reasons[0])) // true
  * ```
@@ -523,7 +558,7 @@ export declare const fail: <E>(error: E) => Cause<E>;
  */
 export declare const die: (defect: unknown) => Cause<never>;
 /**
- * Creates a {@link Cause} containing a single {@link Interrupt} reason,
+ * Creates a `Cause` containing a single `Interrupt` reason,
  * optionally carrying the interrupting fiber's ID.
  *
  * **Example** (creating an interrupt cause)
@@ -544,12 +579,12 @@ export declare const die: (defect: unknown) => Cause<never>;
  */
 export declare const interrupt: (fiberId?: number | undefined) => Cause<never>;
 /**
- * Creates a standalone {@link Fail} reason (not wrapped in a {@link Cause}).
+ * Creates a standalone `Fail` reason (not wrapped in a `Cause`).
  *
  * **When to use**
  *
- * Use this when you need to construct individual reasons for
- * {@link fromReasons} or for direct comparison.
+ * Use when constructing a standalone typed failure reason for
+ * {@link fromReasons} or direct comparison.
  *
  * **Example** (creating a Fail reason)
  *
@@ -569,15 +604,21 @@ export declare const interrupt: (fiberId?: number | undefined) => Cause<never>;
  */
 export declare const makeFailReason: <E>(error: E) => Fail<E>;
 /**
- * Creates a standalone {@link Die} reason (not wrapped in a {@link Cause}).
+ * Creates a standalone `Die` reason (not wrapped in a `Cause`).
+ *
+ * **When to use**
+ *
+ * Use when constructing a standalone defect reason for {@link fromReasons} or
+ * direct comparison.
  *
  * **Example** (creating a Die reason)
  *
  * ```ts
  * import { Cause } from "effect"
  *
- * const reason = Cause.makeDieReason(new Error("bug"))
+ * const reason = Cause.makeDieReason("bug")
  * console.log(reason._tag) // "Die"
+ * console.log(reason.defect) // "bug"
  * ```
  *
  * @see {@link makeFailReason} — create a `Fail` reason
@@ -588,9 +629,14 @@ export declare const makeFailReason: <E>(error: E) => Fail<E>;
  */
 export declare const makeDieReason: (defect: unknown) => Die;
 /**
- * Creates a standalone {@link Interrupt} reason (not wrapped in a {@link Cause}),
+ * Creates a standalone `Interrupt` reason (not wrapped in a `Cause`),
  * optionally carrying the interrupting fiber's ID.
  *
+ * **When to use**
+ *
+ * Use when constructing a standalone interrupt reason for {@link fromReasons}
+ * or direct comparison.
+ *
  * **Example** (creating an Interrupt reason)
  *
  * ```ts
@@ -609,12 +655,12 @@ export declare const makeDieReason: (defect: unknown) => Die;
  */
 export declare const makeInterruptReason: (fiberId?: number | undefined) => Interrupt;
 /**
- * Returns `true` if every reason in the cause is an {@link Interrupt} (and
+ * Returns `true` if every reason in the cause is an `Interrupt` (and
  * there is at least one reason).
  *
  * **When to use**
  *
- * Useful for deciding whether a failure was entirely due to interruption and
+ * Use when deciding whether a failure was entirely due to interruption and
  * can be silently discarded.
  *
  * **Example** (checking interrupt-only causes)
@@ -634,13 +680,20 @@ export declare const makeInterruptReason: (fiberId?: number | undefined) => Inte
  */
 export declare const hasInterruptsOnly: <E>(self: Cause<E>) => boolean;
 /**
- * Transforms the typed error values inside a {@link Cause} using the
- * provided function. Only {@link Fail} reasons are affected; {@link Die}
- * and {@link Interrupt} reasons pass through unchanged.
+ * Transforms the typed error values inside a `Cause` using the
+ * provided function. Only `Fail` reasons are affected; `Die` and `Interrupt`
+ * reasons pass through unchanged.
+ *
+ * **When to use**
+ *
+ * Use to transform expected typed failures while preserving defects and
+ * interruptions unchanged.
  *
  * **Details**
  *
- * Returns a new `Cause`; does not mutate the original.
+ * If at least one `Fail` reason exists, this returns a new `Cause`
+ * containing the mapped failures. If the cause has no `Fail` reasons, the
+ * original cause is returned unchanged.
  *
  * **Example** (mapping errors to uppercase)
  *
@@ -660,13 +713,20 @@ export declare const hasInterruptsOnly: <E>(self: Cause<E>) => boolean;
  */
 export declare const map: {
     /**
-     * Transforms the typed error values inside a {@link Cause} using the
-     * provided function. Only {@link Fail} reasons are affected; {@link Die}
-     * and {@link Interrupt} reasons pass through unchanged.
+     * Transforms the typed error values inside a `Cause` using the
+     * provided function. Only `Fail` reasons are affected; `Die` and `Interrupt`
+     * reasons pass through unchanged.
+     *
+     * **When to use**
+     *
+     * Use to transform expected typed failures while preserving defects and
+     * interruptions unchanged.
      *
      * **Details**
      *
-     * Returns a new `Cause`; does not mutate the original.
+     * If at least one `Fail` reason exists, this returns a new `Cause`
+     * containing the mapped failures. If the cause has no `Fail` reasons, the
+     * original cause is returned unchanged.
      *
      * **Example** (mapping errors to uppercase)
      *
@@ -686,13 +746,20 @@ export declare const map: {
      */
     <E, E2>(f: (error: Types.NoInfer<E>) => E2): (self: Cause<E>) => Cause<E2>;
     /**
-     * Transforms the typed error values inside a {@link Cause} using the
-     * provided function. Only {@link Fail} reasons are affected; {@link Die}
-     * and {@link Interrupt} reasons pass through unchanged.
+     * Transforms the typed error values inside a `Cause` using the
+     * provided function. Only `Fail` reasons are affected; `Die` and `Interrupt`
+     * reasons pass through unchanged.
+     *
+     * **When to use**
+     *
+     * Use to transform expected typed failures while preserving defects and
+     * interruptions unchanged.
      *
      * **Details**
      *
-     * Returns a new `Cause`; does not mutate the original.
+     * If at least one `Fail` reason exists, this returns a new `Cause`
+     * containing the mapped failures. If the cause has no `Fail` reasons, the
+     * original cause is returned unchanged.
      *
      * **Example** (mapping errors to uppercase)
      *
@@ -716,9 +783,13 @@ export declare const map: {
  * Merges two causes into a single cause whose `reasons` array is the union
  * of both inputs (de-duplicated by value equality).
  *
+ * **When to use**
+ *
+ * Use to merge independent causes into one structured failure value.
+ *
  * **Details**
  *
- * - Combining with {@link empty} returns the other cause unchanged.
+ * - Combining with `empty` returns the other cause unchanged.
  * - If the result is structurally equal to `self`, `self` is returned
  *   (referential shortcut).
  *
@@ -734,6 +805,7 @@ export declare const map: {
  * ```
  *
  * @see {@link fromReasons} — build a cause from an array of reasons
+ * @see {@link empty} for the identity cause used when combining
  *
  * @category combining
  * @since 4.0.0
@@ -743,9 +815,13 @@ export declare const combine: {
      * Merges two causes into a single cause whose `reasons` array is the union
      * of both inputs (de-duplicated by value equality).
      *
+     * **When to use**
+     *
+     * Use to merge independent causes into one structured failure value.
+     *
      * **Details**
      *
-     * - Combining with {@link empty} returns the other cause unchanged.
+     * - Combining with `empty` returns the other cause unchanged.
      * - If the result is structurally equal to `self`, `self` is returned
      *   (referential shortcut).
      *
@@ -761,6 +837,7 @@ export declare const combine: {
      * ```
      *
      * @see {@link fromReasons} — build a cause from an array of reasons
+     * @see {@link empty} for the identity cause used when combining
      *
      * @category combining
      * @since 4.0.0
@@ -770,9 +847,13 @@ export declare const combine: {
      * Merges two causes into a single cause whose `reasons` array is the union
      * of both inputs (de-duplicated by value equality).
      *
+     * **When to use**
+     *
+     * Use to merge independent causes into one structured failure value.
+     *
      * **Details**
      *
-     * - Combining with {@link empty} returns the other cause unchanged.
+     * - Combining with `empty` returns the other cause unchanged.
      * - If the result is structurally equal to `self`, `self` is returned
      *   (referential shortcut).
      *
@@ -788,6 +869,7 @@ export declare const combine: {
      * ```
      *
      * @see {@link fromReasons} — build a cause from an array of reasons
+     * @see {@link empty} for the identity cause used when combining
      *
      * @category combining
      * @since 4.0.0
@@ -795,15 +877,20 @@ export declare const combine: {
     <E, E2>(self: Cause<E>, that: Cause<E2>): Cause<E | E2>;
 };
 /**
- * Collapses a {@link Cause} into a single `unknown` value, picking the "most
+ * Collapses a `Cause` into a single `unknown` value, picking the "most
  * important" failure in this order:
  *
+ * **When to use**
+ *
+ * Use to collapse a structured cause to the single value that synchronous and
+ * promise runners would throw.
+ *
  * **Details**
  *
- * 1. First {@link Fail} error (the `E` value)
- * 2. First {@link Die} defect
+ * 1. First `Fail` error (the `E` value)
+ * 2. First `Die` defect
  * 3. A generic `Error("All fibers interrupted without error")` for interrupt-only causes
- * 4. A generic `Error("Empty cause")` for {@link empty}
+ * 4. A generic `Error("Empty cause")` for `empty`
  *
  * This is the function used by `Effect.runPromise` and `Effect.runSync` to
  * decide what to throw.
@@ -830,7 +917,12 @@ export declare const combine: {
  */
 export declare const squash: <E>(self: Cause<E>) => unknown;
 /**
- * Returns `true` if the cause contains at least one {@link Fail} reason.
+ * Returns `true` if the cause contains at least one `Fail` reason.
+ *
+ * **When to use**
+ *
+ * Use to check whether a cause includes typed failures before extracting,
+ * mapping, or rendering them.
  *
  * **Example** (checking for typed errors)
  *
@@ -849,14 +941,14 @@ export declare const squash: <E>(self: Cause<E>) => unknown;
  */
 export declare const hasFails: <E>(self: Cause<E>) => boolean;
 /**
- * Returns a `Result` whose success value is the first {@link Fail} reason in
+ * Returns a `Result` whose success value is the first `Fail` reason in
  * the cause, including its annotations. If the cause has no `Fail` reason, the
  * failure value is the original cause narrowed to `Cause<never>`, because it
  * contains no typed error reasons.
  *
  * **When to use**
  *
- * Use {@link findError} if you only need the unwrapped error value `E`.
+ * Use when you use {@link findError} if you only need the unwrapped error value `E`.
  *
  * **Example** (extracting the first Fail reason)
  *
@@ -872,19 +964,19 @@ export declare const hasFails: <E>(self: Cause<E>) => boolean;
  * @see {@link findError} — extract the unwrapped `E` value
  * @see {@link findDie} — extract the first `Die` reason
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export declare const findFail: <E>(self: Cause<E>) => Result.Result<Fail<E>, Cause<never>>;
 /**
  * Returns a `Result` whose success value is the first typed error value `E`
- * from a {@link Fail} reason in the cause. If the cause has no `Fail` reason,
+ * from a `Fail` reason in the cause. If the cause has no `Fail` reason,
  * the failure value is the original cause narrowed to `Cause<never>`, because
  * it contains no typed error reasons.
  *
  * **When to use**
  *
- * Use {@link findFail} if you need the full {@link Fail} reason (including
+ * Use when you use {@link findFail} if you need the full `Fail` reason (including
  * annotations). Use {@link findErrorOption} if you prefer an `Option`.
  *
  * **Example** (extracting the first error value)
@@ -901,17 +993,17 @@ export declare const findFail: <E>(self: Cause<E>) => Result.Result<Fail<E>, Cau
  * @see {@link findFail} — extract the full `Fail` reason
  * @see {@link findErrorOption} — `Option`-based variant
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export declare const findError: <E>(self: Cause<E>) => Result.Result<E, Cause<never>>;
 /**
  * Returns the first typed error value `E` from a cause wrapped in
- * `Option.some`, or `Option.none` if no {@link Fail} reason exists.
+ * `Option.some`, or `Option.none` if no `Fail` reason exists.
  *
  * **When to use**
  *
- * This is the `Option`-returning variant of {@link findError} for code that
+ * Use when this is the `Option`-returning variant of {@link findError} for code that
  * does not need the original cause returned in a failed `Result`.
  *
  * **Example** (extracting an error as Option)
@@ -926,14 +1018,19 @@ export declare const findError: <E>(self: Cause<E>) => Result.Result<E, Cause<ne
  * console.log(Option.isNone(none)) // true
  * ```
  *
- * @see {@link findError} — `Filter`-based variant
+ * @see {@link findError} — `Result`-based variant
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export declare const findErrorOption: <E>(input: Cause<E>) => Option<E>;
 /**
- * Returns `true` if the cause contains at least one {@link Die} reason.
+ * Returns `true` if the cause contains at least one `Die` reason.
+ *
+ * **When to use**
+ *
+ * Use to check whether a cause includes defects before extracting or rendering
+ * them.
  *
  * **Example** (checking for defects)
  *
@@ -952,13 +1049,13 @@ export declare const findErrorOption: <E>(input: Cause<E>) => Option<E>;
  */
 export declare const hasDies: <E>(self: Cause<E>) => boolean;
 /**
- * Returns a `Result` whose success value is the first {@link Die} reason in
+ * Returns a `Result` whose success value is the first `Die` reason in
  * the cause, including its annotations. If the cause has no `Die` reason, the
  * failure value is the original cause.
  *
  * **When to use**
  *
- * Use {@link findDefect} if you only need the unwrapped defect value.
+ * Use when you use {@link findDefect} if you only need the unwrapped defect value.
  *
  * **Example** (extracting the first Die reason)
  *
@@ -974,18 +1071,18 @@ export declare const hasDies: <E>(self: Cause<E>) => boolean;
  * @see {@link findDefect} — extract the unwrapped defect value
  * @see {@link findFail} — extract the first `Fail` reason
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export declare const findDie: <E>(self: Cause<E>) => Result.Result<Die, Cause<E>>;
 /**
  * Returns a `Result` whose success value is the first defect value from a
- * {@link Die} reason in the cause. If the cause has no `Die` reason, the
+ * `Die` reason in the cause. If the cause has no `Die` reason, the
  * failure value is the original cause.
  *
  * **When to use**
  *
- * Use {@link findDie} if you need the full `Die` reason (including
+ * Use when you use {@link findDie} if you need the full `Die` reason (including
  * annotations).
  *
  * **Example** (extracting the first defect)
@@ -1002,12 +1099,12 @@ export declare const findDie: <E>(self: Cause<E>) => Result.Result<Die, Cause<E>
  * @see {@link findDie} — extract the full `Die` reason
  * @see {@link findError} — extract the first typed error
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export declare const findDefect: <E>(self: Cause<E>) => Result.Result<unknown, Cause<E>>;
 /**
- * Returns `true` if the cause contains at least one {@link Interrupt} reason.
+ * Returns `true` if the cause contains at least one `Interrupt` reason.
  *
  * **Example** (checking for interruptions)
  *
@@ -1027,10 +1124,15 @@ export declare const findDefect: <E>(self: Cause<E>) => Result.Result<unknown, C
  */
 export declare const hasInterrupts: <E>(self: Cause<E>) => boolean;
 /**
- * Returns a `Result` whose success value is the first {@link Interrupt} reason
+ * Returns a `Result` whose success value is the first `Interrupt` reason
  * in the cause, including its annotations. If the cause has no `Interrupt`
  * reason, the failure value is the original cause.
  *
+ * **When to use**
+ *
+ * Use to extract the first interruption reason when you need its fiber ID and
+ * annotations.
+ *
  * **Example** (extracting the first interrupt)
  *
  * ```ts
@@ -1044,18 +1146,18 @@ export declare const hasInterrupts: <E>(self: Cause<E>) => boolean;
  *
  * @see {@link interruptors} — collect all interrupting fiber IDs as a `Set`
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export declare const findInterrupt: <E>(self: Cause<E>) => Result.Result<Interrupt, Cause<E>>;
 /**
- * Collects the defined fiber IDs from all {@link Interrupt} reasons in the
+ * Collects the defined fiber IDs from all `Interrupt` reasons in the
  * cause into a `ReadonlySet`. Interrupt reasons without a `fiberId` are
  * ignored. Returns an empty set when the cause has no interrupting fiber IDs.
  *
  * **When to use**
  *
- * This always succeeds. Use {@link filterInterruptors} when you want a
+ * Use when this always succeeds. Use {@link filterInterruptors} when you want a
  * `Result` that fails with the original cause if there are no `Interrupt`
  * reasons.
  *
@@ -1068,10 +1170,11 @@ export declare const findInterrupt: <E>(self: Cause<E>) => Result.Result<Interru
  *   Cause.interrupt(1),
  *   Cause.interrupt(2)
  * )
- * console.log(Cause.interruptors(cause)) // Set { 1, 2 }
+ *
+ * console.log(Cause.interruptors(cause)) // Set(2) { 1, 2 }
  * ```
  *
- * @see {@link filterInterruptors} — `Filter`-based variant
+ * @see {@link filterInterruptors} — `Result`-based variant
  *
  * @category accessors
  * @since 2.0.0
@@ -1079,38 +1182,49 @@ export declare const findInterrupt: <E>(self: Cause<E>) => Result.Result<Interru
 export declare const interruptors: <E>(self: Cause<E>) => ReadonlySet<number>;
 /**
  * Returns a `Result` whose success value is the set of defined fiber IDs from
- * the cause's {@link Interrupt} reasons. If the cause has no `Interrupt`
+ * the cause's `Interrupt` reasons. If the cause has no `Interrupt`
  * reason, the failure value is the original cause.
  *
  * **When to use**
  *
- * Use {@link interruptors} if you always want a `Set` without `Result`
+ * Use when you use {@link interruptors} if you always want a `Set` without `Result`
  * wrapping.
  *
- * **Example** (extracting interruptors with Filter)
+ * **Gotchas**
+ *
+ * Interrupt reasons without a `fiberId` still count as interrupts, so the
+ * function succeeds with an empty `Set` when every interrupt reason has an
+ * undefined fiber ID.
+ *
+ * **Example** (extracting interruptors with Result)
  *
  * ```ts
  * import { Cause, Result } from "effect"
  *
  * const result = Cause.filterInterruptors(Cause.interrupt(1))
  * if (!Result.isFailure(result)) {
- *   console.log(result.success) // Set { 1 }
+ *   console.log(result.success) // Set(1) { 1 }
  * }
  * ```
  *
  * @see {@link interruptors} — always-succeeding variant
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export declare const filterInterruptors: <E>(self: Cause<E>) => Result.Result<Set<number>, Cause<E>>;
 /**
- * Converts a {@link Cause} into an `Array<Error>` suitable for logging or
+ * Converts a `Cause` into an `Array<Error>` suitable for logging or
  * rethrowing.
  *
+ * **When to use**
+ *
+ * Use to convert every renderable failure in a cause into individual `Error`
+ * values before logging or rethrowing.
+ *
  * **Details**
  *
- * Each {@link Fail} and {@link Die} reason is converted into a standard
+ * Each `Fail` and `Die` reason is converted into a standard
  * `Error`:
  *
  * - **Objects / Error instances** — `message`, `name`, `stack`, and `cause`
@@ -1120,10 +1234,12 @@ export declare const filterInterruptors: <E>(self: Cause<E>) => Result.Result<Se
  * - **Other primitives** (`null`, `undefined`, numbers, …) — wrapped in an
  *   `Error` with message `"Unknown error: <value>"`.
  *
- * {@link Interrupt} reasons are collected separately. If the cause contains
+ * `Interrupt` reasons are collected separately. If the cause contains
  * **only** interrupts (no `Fail` or `Die`), a single `InterruptError` is
  * returned whose `cause` lists the interrupting fiber IDs.
  *
+ * An empty cause returns an empty array.
+ *
  * **Example** (converting a cause to errors)
  *
  * ```ts
@@ -1142,8 +1258,12 @@ export declare const filterInterruptors: <E>(self: Cause<E>) => Result.Result<Se
  */
 export declare const prettyErrors: <E>(self: Cause<E>) => Array<Error>;
 /**
- * Renders a {@link Cause} as a human-readable string for logging or
- * debugging.
+ * Formats a `Cause` as a human-readable string for logging or debugging.
+ *
+ * **When to use**
+ *
+ * Use to render a whole cause as one human-readable string for logs or
+ * diagnostics.
  *
  * **Details**
  *
@@ -1162,15 +1282,18 @@ export declare const prettyErrors: <E>(self: Cause<E>) => Array<Error>;
  *
  * Span annotations are appended to the relevant stack frames when available.
  *
+ * **Gotchas**
+ *
+ * Rendering an empty cause produces an empty string because there are no
+ * errors to render.
+ *
  * **Example** (rendering a cause)
  *
  * ```ts
  * import { Cause } from "effect"
  *
- * const cause = Cause.fail("something went wrong")
- * console.log(Cause.pretty(cause))
- * // Error: something went wrong
- * //     at ...
+ * const rendered = Cause.pretty(Cause.fail("something went wrong"))
+ * console.log(rendered.includes("something went wrong")) // true
  * ```
  *
  * @see {@link prettyErrors} — get the individual `Error` instances
@@ -1186,10 +1309,9 @@ export declare const pretty: <E>(cause: Cause<E>) => string;
  *
  * **Details**
  *
- * All built-in error classes in this module ({@link NoSuchElementError},
- * {@link TimeoutError}, {@link IllegalArgumentError},
- * {@link ExceededCapacityError}, {@link AsyncFiberError}, and
- * {@link UnknownError}) implement this interface.
+ * All built-in error classes in this module (`NoSuchElementError`,
+ * `TimeoutError`, `IllegalArgumentError`, `ExceededCapacityError`,
+ * `AsyncFiberError`, and `UnknownError`) implement this interface.
  *
  * **Example** (yielding an error in Effect.gen)
  *
@@ -1211,7 +1333,7 @@ export interface YieldableError extends Error, Pipeable, Inspectable {
     [Symbol.iterator](): Effect.EffectIterator<Effect.Effect<never, this, never>>;
 }
 /**
- * Tests if an arbitrary value is a {@link NoSuchElementError}.
+ * Checks whether an arbitrary value is a `NoSuchElementError`.
  *
  * **Example** (runtime type check)
  *
@@ -1227,25 +1349,30 @@ export interface YieldableError extends Error, Pipeable, Inspectable {
  */
 export declare const isNoSuchElementError: (u: unknown) => u is NoSuchElementError;
 /**
- * Unique brand for {@link NoSuchElementError}.
+ * Unique brand for `NoSuchElementError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const NoSuchElementErrorTypeId: "~effect/Cause/NoSuchElementError";
 /**
  * An error indicating that an expected value was absent.
  *
+ * **When to use**
+ *
+ * Use to model APIs that intentionally turn absence into an error.
+ *
  * **Details**
  *
  * Used by APIs that convert absence into an exception or effect failure, such
- * as `Option.getOrThrow`. Implements {@link YieldableError} so it can be
+ * as `Option.getOrThrow`. Implements `YieldableError` so it can be
  * yielded directly in `Effect.gen`.
  *
  * **Gotchas**
  *
- * Safe lookup APIs that return `Option` should document the `None` case rather
- * than describing it as a thrown `NoSuchElementError`.
+ * Prefer APIs that return `Option` or a typed failure when absence is an
+ * expected case. This error is mainly for APIs that intentionally turn absence
+ * into a thrown value or failed effect.
  *
  * **Example** (creating and checking)
  *
@@ -1257,9 +1384,6 @@ export declare const NoSuchElementErrorTypeId: "~effect/Cause/NoSuchElementError
  * console.log(error.message) // "Element not found"
  * ```
  *
- * @see {@link isNoSuchElementError} — type guard
- * @see {@link NoSuchElementError:var | NoSuchElementError constructor}
- *
  * @category errors
  * @since 4.0.0
  */
@@ -1268,7 +1392,12 @@ export interface NoSuchElementError extends YieldableError {
     readonly _tag: "NoSuchElementError";
 }
 /**
- * Constructs a {@link NoSuchElementError} with an optional message.
+ * Constructs a `NoSuchElementError` with an optional message.
+ *
+ * **When to use**
+ *
+ * Use to create the error value for APIs that intentionally fail when an
+ * expected element is absent.
  *
  * **Example** (creating a NoSuchElementError)
  *
@@ -1279,12 +1408,14 @@ export interface NoSuchElementError extends YieldableError {
  * console.log(error.message) // "Element not found"
  * ```
  *
+ * @see {@link isNoSuchElementError} for checking unknown values
+ *
  * @category constructors
  * @since 4.0.0
  */
 export declare const NoSuchElementError: new (message?: string) => NoSuchElementError;
 /**
- * Tests if an arbitrary value is a {@link Done} signal.
+ * Checks whether an arbitrary value is a `Done` signal.
  *
  * **Example** (runtime type check)
  *
@@ -1300,15 +1431,20 @@ export declare const NoSuchElementError: new (message?: string) => NoSuchElement
  */
 export declare const isDone: (u: unknown) => u is Done<any>;
 /**
- * Unique brand for {@link Done} values.
+ * Unique brand for `Done` values.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const DoneTypeId: "~effect/Cause/Done";
 /**
  * A graceful completion signal for queues and streams.
  *
+ * **When to use**
+ *
+ * Use to model normal producer completion through a stream or queue error
+ * channel.
+ *
  * **Details**
  *
  * `Done` indicates that a producer has finished normally — no more elements
@@ -1331,9 +1467,6 @@ export declare const DoneTypeId: "~effect/Cause/Done";
  * })
  * ```
  *
- * @see {@link isDone} — type guard
- * @see {@link done} — create a failing Effect with `Done`
- *
  * @category errors
  * @since 4.0.0
  */
@@ -1343,7 +1476,7 @@ export interface Done<A = void> {
     readonly value: A;
 }
 /**
- * Companion namespace for the {@link Done} interface.
+ * Companion namespace for the `Done` interface.
  *
  * @since 4.0.0
  */
@@ -1365,7 +1498,12 @@ export declare namespace Done {
     type Only<E> = E extends Done<infer L> ? Done<L> : never;
 }
 /**
- * Creates a {@link Done} signal with an optional value.
+ * Creates a `Done` signal with an optional value.
+ *
+ * **When to use**
+ *
+ * Use when you need the completion signal value itself. Use {@link done}
+ * when you need an `Effect` that fails with the signal.
  *
  * @see {@link done} — create a failing `Effect` with `Done`
  *
@@ -1374,24 +1512,41 @@ export declare namespace Done {
  */
 export declare const Done: <A = void>(value?: A) => Done<A>;
 /**
- * Creates an Effect that fails with a {@link Done} error. Shorthand for
+ * Creates an Effect that fails with a `Done` error. Shorthand for
  * `Effect.fail(Cause.Done(value))`.
  *
- * @see {@link Done:var | Done} — create the signal value without an Effect
+ * **When to use**
+ *
+ * Use when you use this in effect workflows that model stream or queue completion through
+ * the error channel.
+ *
+ * **Example** (failing with Done)
+ *
+ * ```ts
+ * import { Cause, Effect } from "effect"
+ *
+ * const program = Cause.done("finished")
+ *
+ * Effect.runPromiseExit(program).then((exit) => {
+ *   console.log(exit._tag) // "Failure"
+ * })
+ * ```
+ *
+ * @see {@link Done} — create the signal value without an Effect
  *
  * @category constructors
  * @since 4.0.0
  */
 export declare const done: <A = void>(value?: A) => Effect.Effect<never, Done<A>>;
 /**
- * Unique brand for {@link TimeoutError}.
+ * Unique brand for `TimeoutError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TimeoutErrorTypeId: "~effect/Cause/TimeoutError";
 /**
- * Tests if an arbitrary value is a {@link TimeoutError}.
+ * Checks whether an arbitrary value is a `TimeoutError`.
  *
  * **Example** (runtime type check)
  *
@@ -1412,7 +1567,7 @@ export declare const isTimeoutError: (u: unknown) => u is TimeoutError;
  * **Details**
  *
  * Produced by `Effect.timeout` and related APIs. Implements
- * {@link YieldableError}.
+ * `YieldableError`.
  *
  * **Example** (creating and checking)
  *
@@ -1424,8 +1579,6 @@ export declare const isTimeoutError: (u: unknown) => u is TimeoutError;
  * console.log(error.message) // "Operation timed out"
  * ```
  *
- * @see {@link isTimeoutError} — type guard
- *
  * @category errors
  * @since 4.0.0
  */
@@ -1434,7 +1587,7 @@ export interface TimeoutError extends YieldableError {
     readonly _tag: "TimeoutError";
 }
 /**
- * Constructs a {@link TimeoutError} with an optional message.
+ * Constructs a `TimeoutError` with an optional message.
  *
  * **Example** (creating a TimeoutError)
  *
@@ -1450,14 +1603,14 @@ export interface TimeoutError extends YieldableError {
  */
 export declare const TimeoutError: new (message?: string) => TimeoutError;
 /**
- * Unique brand for {@link IllegalArgumentError}.
+ * Unique brand for `IllegalArgumentError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const IllegalArgumentErrorTypeId: "~effect/Cause/IllegalArgumentError";
 /**
- * Tests if an arbitrary value is an {@link IllegalArgumentError}.
+ * Checks whether an arbitrary value is an `IllegalArgumentError`.
  *
  * **Example** (runtime type check)
  *
@@ -1478,7 +1631,7 @@ export declare const isIllegalArgumentError: (u: unknown) => u is IllegalArgumen
  *
  * **Details**
  *
- * Implements {@link YieldableError}.
+ * Implements `YieldableError`.
  *
  * **Example** (creating and checking)
  *
@@ -1490,8 +1643,6 @@ export declare const isIllegalArgumentError: (u: unknown) => u is IllegalArgumen
  * console.log(error.message) // "Expected positive number"
  * ```
  *
- * @see {@link isIllegalArgumentError} — type guard
- *
  * @category errors
  * @since 4.0.0
  */
@@ -1500,7 +1651,7 @@ export interface IllegalArgumentError extends YieldableError {
     readonly _tag: "IllegalArgumentError";
 }
 /**
- * Constructs an {@link IllegalArgumentError} with an optional message.
+ * Constructs an `IllegalArgumentError` with an optional message.
  *
  * **Example** (creating an IllegalArgumentError)
  *
@@ -1516,7 +1667,7 @@ export interface IllegalArgumentError extends YieldableError {
  */
 export declare const IllegalArgumentError: new (message?: string) => IllegalArgumentError;
 /**
- * Tests if an arbitrary value is an {@link ExceededCapacityError}.
+ * Checks whether an arbitrary value is an `ExceededCapacityError`.
  *
  * **Example** (runtime type check)
  *
@@ -1532,9 +1683,9 @@ export declare const IllegalArgumentError: new (message?: string) => IllegalArgu
  */
 export declare const isExceededCapacityError: (u: unknown) => u is ExceededCapacityError;
 /**
- * Unique brand for {@link ExceededCapacityError}.
+ * Unique brand for `ExceededCapacityError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const ExceededCapacityErrorTypeId: "~effect/Cause/ExceededCapacityError";
@@ -1542,9 +1693,14 @@ export declare const ExceededCapacityErrorTypeId: "~effect/Cause/ExceededCapacit
  * An error indicating that a bounded resource (queue, pool, semaphore, etc.)
  * has exceeded its capacity.
  *
+ * **When to use**
+ *
+ * Use to model bounded-resource failures where an operation cannot proceed
+ * because capacity has been exhausted.
+ *
  * **Details**
  *
- * Implements {@link YieldableError}.
+ * Implements `YieldableError`.
  *
  * **Example** (creating and checking)
  *
@@ -1556,8 +1712,6 @@ export declare const ExceededCapacityErrorTypeId: "~effect/Cause/ExceededCapacit
  * console.log(error.message) // "Queue full"
  * ```
  *
- * @see {@link isExceededCapacityError} — type guard
- *
  * @category errors
  * @since 4.0.0
  */
@@ -1566,7 +1720,11 @@ export interface ExceededCapacityError extends YieldableError {
     readonly _tag: "ExceededCapacityError";
 }
 /**
- * Constructs an {@link ExceededCapacityError} with an optional message.
+ * Constructs an `ExceededCapacityError` with an optional message.
+ *
+ * **When to use**
+ *
+ * Use to create the error value for bounded-resource capacity failures.
  *
  * **Example** (creating an ExceededCapacityError)
  *
@@ -1577,19 +1735,35 @@ export interface ExceededCapacityError extends YieldableError {
  * console.log(error.message) // "Queue full"
  * ```
  *
+ * @see {@link isExceededCapacityError} for checking unknown values
+ *
  * @category constructors
  * @since 4.0.0
  */
 export declare const ExceededCapacityError: new (message?: string) => ExceededCapacityError;
 /**
- * Unique brand for {@link AsyncFiberError}.
+ * Unique brand present on `AsyncFiberError` values and used by
+ * `isAsyncFiberError` for runtime checks.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const AsyncFiberErrorTypeId: "~effect/Cause/AsyncFiberError";
 /**
- * Tests if an arbitrary value is an {@link AsyncFiberError}.
+ * Checks whether an arbitrary value is an `AsyncFiberError`.
+ *
+ * **Example** (runtime type check)
+ *
+ * ```ts
+ * import { Cause } from "effect"
+ * import type { Fiber } from "effect"
+ *
+ * declare const fiber: Fiber.Fiber<unknown, unknown>
+ *
+ * const error = new Cause.AsyncFiberError(fiber)
+ * console.log(Cause.isAsyncFiberError(error)) // true
+ * console.log(Cause.isAsyncFiberError("nope")) // false
+ * ```
  *
  * @category guards
  * @since 4.0.0
@@ -1598,6 +1772,29 @@ export declare const isAsyncFiberError: (u: unknown) => u is AsyncFiberError;
 /**
  * An error that occurs when trying to run an async fiber with Effect.runSync.
  *
+ * **When to use**
+ *
+ * Use to inspect failures produced when synchronous runners encounter an effect
+ * that cannot complete synchronously.
+ *
+ * **Details**
+ *
+ * The `fiber` property stores the fiber that could not be synchronously
+ * resolved. This error implements `YieldableError`.
+ *
+ * **Example** (accessing the fiber)
+ *
+ * ```ts
+ * import { Cause } from "effect"
+ * import type { Fiber } from "effect"
+ *
+ * declare const fiber: Fiber.Fiber<unknown, unknown>
+ *
+ * const error = new Cause.AsyncFiberError(fiber)
+ * console.log(error._tag) // "AsyncFiberError"
+ * console.log(error.fiber === fiber) // true
+ * ```
+ *
  * @category errors
  * @since 4.0.0
  */
@@ -1607,21 +1804,41 @@ export interface AsyncFiberError extends YieldableError {
     readonly fiber: Fiber<unknown, unknown>;
 }
 /**
- * An error that occurs when trying to run an async fiber with Effect.runSync.
+ * Constructs an `AsyncFiberError` for a fiber that could not be resolved
+ * synchronously.
+ *
+ * **When to use**
+ *
+ * Use to create the error value for a fiber that could not be completed by a
+ * synchronous runner.
+ *
+ * **Example** (creating an AsyncFiberError)
+ *
+ * ```ts
+ * import { Cause } from "effect"
+ * import type { Fiber } from "effect"
+ *
+ * declare const fiber: Fiber.Fiber<unknown, unknown>
+ *
+ * const error = new Cause.AsyncFiberError(fiber)
+ * console.log(error.message) // "An asynchronous Effect was executed with Effect.runSync"
+ * ```
+ *
+ * @see {@link isAsyncFiberError} for checking unknown values
  *
  * @category constructors
  * @since 4.0.0
  */
 export declare const AsyncFiberError: new (fiber: Fiber<unknown, unknown>) => AsyncFiberError;
 /**
- * Unique brand for {@link UnknownError}.
+ * Unique brand for `UnknownError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const UnknownErrorTypeId: "~effect/Cause/UnknownError";
 /**
- * Tests if an arbitrary value is an {@link UnknownError}.
+ * Checks whether an arbitrary value is an `UnknownError`.
  *
  * **Example** (runtime type check)
  *
@@ -1641,9 +1858,9 @@ export declare const isUnknownError: (u: unknown) => u is UnknownError;
  *
  * **Details**
  *
- * Produced by the runtime when an effect throws a non-`Error` value.
- * The original thrown value is stored in the `cause` property (inherited
- * from `Error`). Implements {@link YieldableError}.
+ * Used when a thrown or rejected value is not represented by a more specific
+ * typed error. The original value is stored in the `cause` property inherited
+ * from `Error`. Implements `YieldableError`.
  *
  * **Example** (creating and checking)
  *
@@ -1655,8 +1872,6 @@ export declare const isUnknownError: (u: unknown) => u is UnknownError;
  * console.log(error.message) // "Something unknown"
  * ```
  *
- * @see {@link isUnknownError} — type guard
- *
  * @category errors
  * @since 4.0.0
  */
@@ -1665,7 +1880,7 @@ export interface UnknownError extends YieldableError {
     readonly _tag: "UnknownError";
 }
 /**
- * Constructs an {@link UnknownError}. The first argument is the original
+ * Constructs an `UnknownError`. The first argument is the original
  * cause (stored in `Error.cause`); the second is an optional human-readable
  * message.
  *
@@ -1683,7 +1898,11 @@ export interface UnknownError extends YieldableError {
  */
 export declare const UnknownError: new (cause: unknown, message?: string) => UnknownError;
 /**
- * Attaches metadata to every reason in a {@link Cause}.
+ * Attaches metadata to every reason in a `Cause`.
+ *
+ * **When to use**
+ *
+ * Use to attach diagnostic metadata to every reason in a cause.
  *
  * **Details**
  *
@@ -1691,7 +1910,7 @@ export declare const UnknownError: new (cause: unknown, message?: string) => Unk
  * retrieved later via {@link reasonAnnotations} or {@link annotations}.
  * The runtime uses this to attach stack traces and spans.
  *
- * - Returns a new `Cause`; does not mutate the input.
+ * - Returns a new `Cause`.
  * - By default, existing keys are preserved. Pass `{ overwrite: true }` to
  *   replace them.
  *
@@ -1700,19 +1919,27 @@ export declare const UnknownError: new (cause: unknown, message?: string) => Unk
  * ```ts
  * import { Cause, Context } from "effect"
  *
+ * class RequestId extends Context.Service<RequestId, string>()("RequestId") {}
+ *
  * const cause = Cause.fail("error")
- * const annotated = Cause.annotate(cause, Context.empty())
+ * const annotated = Cause.annotate(cause, Context.make(RequestId, "req-1"))
+ *
+ * console.log(Context.getOrUndefined(Cause.annotations(annotated), RequestId)) // "req-1"
  * ```
  *
- * @see {@link annotations} — read merged annotations from a cause
- * @see {@link reasonAnnotations} — read annotations from a single reason
+ * @see {@link annotations} for reading merged annotations from a cause
+ * @see {@link reasonAnnotations} for reading annotations from a single reason
  *
  * @category annotations
  * @since 4.0.0
  */
 export declare const annotate: {
     /**
-     * Attaches metadata to every reason in a {@link Cause}.
+     * Attaches metadata to every reason in a `Cause`.
+     *
+     * **When to use**
+     *
+     * Use to attach diagnostic metadata to every reason in a cause.
      *
      * **Details**
      *
@@ -1720,7 +1947,7 @@ export declare const annotate: {
      * retrieved later via {@link reasonAnnotations} or {@link annotations}.
      * The runtime uses this to attach stack traces and spans.
      *
-     * - Returns a new `Cause`; does not mutate the input.
+     * - Returns a new `Cause`.
      * - By default, existing keys are preserved. Pass `{ overwrite: true }` to
      *   replace them.
      *
@@ -1729,12 +1956,16 @@ export declare const annotate: {
      * ```ts
      * import { Cause, Context } from "effect"
      *
+     * class RequestId extends Context.Service<RequestId, string>()("RequestId") {}
+     *
      * const cause = Cause.fail("error")
-     * const annotated = Cause.annotate(cause, Context.empty())
+     * const annotated = Cause.annotate(cause, Context.make(RequestId, "req-1"))
+     *
+     * console.log(Context.getOrUndefined(Cause.annotations(annotated), RequestId)) // "req-1"
      * ```
      *
-     * @see {@link annotations} — read merged annotations from a cause
-     * @see {@link reasonAnnotations} — read annotations from a single reason
+     * @see {@link annotations} for reading merged annotations from a cause
+     * @see {@link reasonAnnotations} for reading annotations from a single reason
      *
      * @category annotations
      * @since 4.0.0
@@ -1743,7 +1974,11 @@ export declare const annotate: {
         readonly overwrite?: boolean | undefined;
     }): <E>(self: Cause<E>) => Cause<E>;
     /**
-     * Attaches metadata to every reason in a {@link Cause}.
+     * Attaches metadata to every reason in a `Cause`.
+     *
+     * **When to use**
+     *
+     * Use to attach diagnostic metadata to every reason in a cause.
      *
      * **Details**
      *
@@ -1751,7 +1986,7 @@ export declare const annotate: {
      * retrieved later via {@link reasonAnnotations} or {@link annotations}.
      * The runtime uses this to attach stack traces and spans.
      *
-     * - Returns a new `Cause`; does not mutate the input.
+     * - Returns a new `Cause`.
      * - By default, existing keys are preserved. Pass `{ overwrite: true }` to
      *   replace them.
      *
@@ -1760,12 +1995,16 @@ export declare const annotate: {
      * ```ts
      * import { Cause, Context } from "effect"
      *
+     * class RequestId extends Context.Service<RequestId, string>()("RequestId") {}
+     *
      * const cause = Cause.fail("error")
-     * const annotated = Cause.annotate(cause, Context.empty())
+     * const annotated = Cause.annotate(cause, Context.make(RequestId, "req-1"))
+     *
+     * console.log(Context.getOrUndefined(Cause.annotations(annotated), RequestId)) // "req-1"
      * ```
      *
-     * @see {@link annotations} — read merged annotations from a cause
-     * @see {@link reasonAnnotations} — read annotations from a single reason
+     * @see {@link annotations} for reading merged annotations from a cause
+     * @see {@link reasonAnnotations} for reading annotations from a single reason
      *
      * @category annotations
      * @since 4.0.0
@@ -1775,29 +2014,60 @@ export declare const annotate: {
     }): Cause<E>;
 };
 /**
- * Reads the annotations from a single {@link Reason} as a `Context`.
+ * Reads the annotations from a single `Reason` as a `Context`.
  *
  * **When to use**
  *
- * Use this when you need tracing metadata (e.g. {@link StackTrace}) from
+ * Use when you need tracing metadata (e.g. `StackTrace`) from
  * a specific reason rather than the whole cause.
  *
+ * **Example** (reading reason annotations)
+ *
+ * ```ts
+ * import { Cause, Context } from "effect"
+ *
+ * class RequestId extends Context.Service<RequestId, string>()("RequestId") {}
+ *
+ * const reason = Cause.makeFailReason("error")
+ * const annotated = reason.annotate(Context.make(RequestId, "req-1"))
+ *
+ * console.log(Context.getOrUndefined(Cause.reasonAnnotations(annotated), RequestId)) // "req-1"
+ * ```
+ *
  * @see {@link annotations} — merged annotations from all reasons in a cause
- * @see {@link annotate} — attach annotations
  *
  * @category annotations
  * @since 4.0.0
  */
 export declare const reasonAnnotations: <E>(self: Reason<E>) => Context.Context<never>;
 /**
- * Reads the merged annotations from all reasons in a {@link Cause}.
+ * Reads the merged annotations from all reasons in a `Cause`.
  *
- * **Details**
+ * **When to use**
+ *
+ * Use to read diagnostic metadata merged from the whole cause.
+ *
+ * **Gotchas**
+ *
+ * When multiple reasons contain the same annotation key, the value from the
+ * later reason wins.
+ *
+ * **Example** (reading merged annotations)
+ *
+ * ```ts
+ * import { Cause, Context } from "effect"
  *
- * Annotations from later reasons overwrite earlier ones when keys collide.
+ * class RequestId extends Context.Service<RequestId, string>()("RequestId") {}
+ *
+ * const cause = Cause.annotate(
+ *   Cause.fail("error"),
+ *   Context.make(RequestId, "req-1")
+ * )
+ *
+ * console.log(Context.getOrUndefined(Cause.annotations(cause), RequestId)) // "req-1"
+ * ```
  *
  * @see {@link reasonAnnotations} — annotations from a single reason
- * @see {@link annotate} — attach annotations
  *
  * @category annotations
  * @since 4.0.0
@@ -1805,7 +2075,12 @@ export declare const reasonAnnotations: <E>(self: Reason<E>) => Context.Context<
 export declare const annotations: <E>(self: Cause<E>) => Context.Context<never>;
 declare const StackTrace_base: Context.ServiceClass<StackTrace, "effect/Cause/StackTrace", StackFrame>;
 /**
- * `Context` key for the stack frame captured at the point of failure.
+ * Context annotation used to store the stack frame captured at the point of failure.
+ *
+ * **When to use**
+ *
+ * Use to read the failure stack-frame annotation from a `Reason` when building
+ * diagnostics, logging, or custom cause renderers.
  *
  * **Details**
  *
@@ -1813,6 +2088,10 @@ declare const StackTrace_base: Context.ServiceClass<StackTrace, "effect/Cause/St
  * available. Retrieve it via
  * `Context.get(Cause.reasonAnnotations(reason), Cause.StackTrace)`.
  *
+ * @see {@link reasonAnnotations} for reading annotations from a single reason
+ * @see {@link annotations} for reading merged annotations from a cause
+ * @see {@link InterruptorStackTrace} for the interrupt-specific stack-frame annotation
+ *
  * @category annotations
  * @since 4.0.0
  */
@@ -1820,12 +2099,21 @@ export declare class StackTrace extends StackTrace_base {
 }
 declare const InterruptorStackTrace_base: Context.ServiceClass<InterruptorStackTrace, "effect/Cause/InterruptorStackTrace", StackFrame>;
 /**
- * `Context` key for the stack frame captured at the point of
+ * Context annotation used to store the stack frame captured at the point of
  * interruption.
  *
+ * **When to use**
+ *
+ * Use when attaching or reading the stack-frame annotation consumed by
+ * interrupt-only cause rendering.
+ *
  * **Details**
  *
- * Similar to {@link StackTrace} but specific to {@link Interrupt} reasons.
+ * Similar to `StackTrace` but specific to `Interrupt` reasons.
+ *
+ * @see {@link StackTrace} for stack frames attached to failures
+ * @see {@link reasonAnnotations} for reading annotations from a single reason
+ * @see {@link annotate} for attaching annotations to a cause
  *
  * @category annotations
  * @since 4.0.0