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

package/dist/Cause.js

@@ -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.js";
@@ -83,19 +81,19 @@ import * as effect from "./internal/effect.js";
 /**
  * Unique brand for `Cause` values, used for runtime type checks via {@link isCause}.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = core.CauseTypeId;
 /**
  * Unique brand for `Reason` values, used for runtime type checks via {@link isReason}.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const ReasonTypeId = core.CauseReasonTypeId;
 /**
- * Tests if an arbitrary value is a {@link Cause}.
+ * Checks whether an arbitrary value is a `Cause`.
  *
  * **Example** (runtime type check)
  *
@@ -111,7 +109,7 @@ export const ReasonTypeId = core.CauseReasonTypeId;
  */
 export const isCause = core.isCause;
 /**
- * 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)
  *
@@ -128,11 +126,12 @@ export const isCause = core.isCause;
  */
 export const isReason = core.isCauseReason;
 /**
- * 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)
  *
@@ -152,11 +151,12 @@ export const isReason = core.isCauseReason;
  */
 export const isFailReason = core.isFailReason;
 /**
- * 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)
  *
@@ -176,11 +176,12 @@ export const isFailReason = core.isFailReason;
  */
 export const isDieReason = core.isDieReason;
 /**
- * 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)
  *
@@ -200,18 +201,23 @@ export const isDieReason = core.isDieReason;
  */
 export const isInterruptReason = core.isInterruptReason;
 /**
- * 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)
  *
@@ -233,23 +239,43 @@ export const isInterruptReason = core.isInterruptReason;
  */
 export const fromReasons = core.causeFromReasons;
 /**
- * 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 const empty = core.causeEmpty;
 /**
- * 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
@@ -268,15 +294,19 @@ export const empty = core.causeEmpty;
  */
 export const fail = core.causeFail;
 /**
- * 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
  * ```
@@ -289,7 +319,7 @@ export const fail = core.causeFail;
  */
 export const die = core.causeDie;
 /**
- * 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)
@@ -310,12 +340,12 @@ export const die = core.causeDie;
  */
 export const interrupt = effect.causeInterrupt;
 /**
- * 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)
  *
@@ -335,15 +365,21 @@ export const interrupt = effect.causeInterrupt;
  */
 export const makeFailReason = error => new core.Fail(error);
 /**
- * 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
@@ -354,9 +390,14 @@ export const makeFailReason = error => new core.Fail(error);
  */
 export const makeDieReason = defect => new core.Die(defect);
 /**
- * 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
@@ -375,12 +416,12 @@ export const makeDieReason = defect => new core.Die(defect);
  */
 export const makeInterruptReason = effect.makeInterruptReason;
 /**
- * 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)
@@ -400,13 +441,20 @@ export const makeInterruptReason = effect.makeInterruptReason;
  */
 export const hasInterruptsOnly = effect.hasInterruptsOnly;
 /**
- * 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)
  *
@@ -429,9 +477,13 @@ export const map = effect.causeMap;
  * 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).
  *
@@ -447,21 +499,27 @@ export const map = effect.causeMap;
  * ```
  *
  * @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
  */
 export const combine = effect.causeCombine;
 /**
- * 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.
@@ -488,7 +546,12 @@ export const combine = effect.causeCombine;
  */
 export const squash = effect.causeSquash;
 /**
- * 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)
  *
@@ -507,14 +570,14 @@ export const squash = effect.causeSquash;
  */
 export const hasFails = effect.hasFails;
 /**
- * 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)
  *
@@ -530,19 +593,19 @@ export const hasFails = effect.hasFails;
  * @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 const findFail = effect.findFail;
 /**
  * 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)
@@ -559,17 +622,17 @@ export const findFail = effect.findFail;
  * @see {@link findFail} — extract the full `Fail` reason
  * @see {@link findErrorOption} — `Option`-based variant
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const findError = effect.findError;
 /**
  * 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)
@@ -584,14 +647,19 @@ export const findError = effect.findError;
  * 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 const findErrorOption = effect.findErrorOption;
 /**
- * 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)
  *
@@ -610,13 +678,13 @@ export const findErrorOption = effect.findErrorOption;
  */
 export const hasDies = effect.hasDies;
 /**
- * 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)
  *
@@ -632,18 +700,18 @@ export const hasDies = effect.hasDies;
  * @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 const findDie = effect.findDie;
 /**
  * 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)
@@ -660,12 +728,12 @@ export const findDie = effect.findDie;
  * @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 const findDefect = effect.findDefect;
 /**
- * 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)
  *
@@ -685,10 +753,15 @@ export const findDefect = effect.findDefect;
  */
 export const hasInterrupts = effect.hasInterrupts;
 /**
- * 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
@@ -702,18 +775,18 @@ export const hasInterrupts = effect.hasInterrupts;
  *
  * @see {@link interruptors} — collect all interrupting fiber IDs as a `Set`
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const findInterrupt = effect.findInterrupt;
 /**
- * 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.
  *
@@ -726,10 +799,11 @@ export const findInterrupt = effect.findInterrupt;
  *   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
@@ -737,38 +811,49 @@ export const findInterrupt = effect.findInterrupt;
 export const interruptors = effect.causeInterruptors;
 /**
  * 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 const filterInterruptors = effect.causeFilterInterruptors;
 /**
- * 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`
@@ -778,10 +863,12 @@ export const filterInterruptors = effect.causeFilterInterruptors;
  * - **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
@@ -800,8 +887,12 @@ export const filterInterruptors = effect.causeFilterInterruptors;
  */
 export const prettyErrors = effect.causePrettyErrors;
 /**
- * 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**
  *
@@ -820,15 +911,18 @@ export const prettyErrors = effect.causePrettyErrors;
  *
  * 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
@@ -838,7 +932,7 @@ export const prettyErrors = effect.causePrettyErrors;
  */
 export const pretty = effect.causePretty;
 /**
- * Tests if an arbitrary value is a {@link NoSuchElementError}.
+ * Checks whether an arbitrary value is a `NoSuchElementError`.
  *
  * **Example** (runtime type check)
  *
@@ -854,14 +948,19 @@ export const pretty = effect.causePretty;
  */
 export const isNoSuchElementError = core.isNoSuchElementError;
 /**
- * Unique brand for {@link NoSuchElementError}.
+ * Unique brand for `NoSuchElementError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const NoSuchElementErrorTypeId = core.NoSuchElementErrorTypeId;
 /**
- * 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)
  *
@@ -872,12 +971,14 @@ export const NoSuchElementErrorTypeId = core.NoSuchElementErrorTypeId;
  * console.log(error.message) // "Element not found"
  * ```
  *
+ * @see {@link isNoSuchElementError} for checking unknown values
+ *
  * @category constructors
  * @since 4.0.0
  */
 export const NoSuchElementError = core.NoSuchElementError;
 /**
- * Tests if an arbitrary value is a {@link Done} signal.
+ * Checks whether an arbitrary value is a `Done` signal.
  *
  * **Example** (runtime type check)
  *
@@ -893,14 +994,19 @@ export const NoSuchElementError = core.NoSuchElementError;
  */
 export const isDone = core.isDone;
 /**
- * Unique brand for {@link Done} values.
+ * Unique brand for `Done` values.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const DoneTypeId = core.DoneTypeId;
 /**
- * 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`
  *
@@ -909,24 +1015,41 @@ export const DoneTypeId = core.DoneTypeId;
  */
 export const Done = core.Done;
 /**
- * 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 const done = core.done;
 /**
- * Unique brand for {@link TimeoutError}.
+ * Unique brand for `TimeoutError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const TimeoutErrorTypeId = effect.TimeoutErrorTypeId;
 /**
- * Tests if an arbitrary value is a {@link TimeoutError}.
+ * Checks whether an arbitrary value is a `TimeoutError`.
  *
  * **Example** (runtime type check)
  *
@@ -942,7 +1065,7 @@ export const TimeoutErrorTypeId = effect.TimeoutErrorTypeId;
  */
 export const isTimeoutError = effect.isTimeoutError;
 /**
- * Constructs a {@link TimeoutError} with an optional message.
+ * Constructs a `TimeoutError` with an optional message.
  *
  * **Example** (creating a TimeoutError)
  *
@@ -958,14 +1081,14 @@ export const isTimeoutError = effect.isTimeoutError;
  */
 export const TimeoutError = effect.TimeoutError;
 /**
- * Unique brand for {@link IllegalArgumentError}.
+ * Unique brand for `IllegalArgumentError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const IllegalArgumentErrorTypeId = effect.IllegalArgumentErrorTypeId;
 /**
- * Tests if an arbitrary value is an {@link IllegalArgumentError}.
+ * Checks whether an arbitrary value is an `IllegalArgumentError`.
  *
  * **Example** (runtime type check)
  *
@@ -981,7 +1104,7 @@ export const IllegalArgumentErrorTypeId = effect.IllegalArgumentErrorTypeId;
  */
 export const isIllegalArgumentError = effect.isIllegalArgumentError;
 /**
- * Constructs an {@link IllegalArgumentError} with an optional message.
+ * Constructs an `IllegalArgumentError` with an optional message.
  *
  * **Example** (creating an IllegalArgumentError)
  *
@@ -997,7 +1120,7 @@ export const isIllegalArgumentError = effect.isIllegalArgumentError;
  */
 export const IllegalArgumentError = effect.IllegalArgumentError;
 /**
- * Tests if an arbitrary value is an {@link ExceededCapacityError}.
+ * Checks whether an arbitrary value is an `ExceededCapacityError`.
  *
  * **Example** (runtime type check)
  *
@@ -1013,14 +1136,18 @@ export const IllegalArgumentError = effect.IllegalArgumentError;
  */
 export const isExceededCapacityError = effect.isExceededCapacityError;
 /**
- * Unique brand for {@link ExceededCapacityError}.
+ * Unique brand for `ExceededCapacityError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const ExceededCapacityErrorTypeId = effect.ExceededCapacityErrorTypeId;
 /**
- * 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)
  *
@@ -1031,40 +1158,76 @@ export const ExceededCapacityErrorTypeId = effect.ExceededCapacityErrorTypeId;
  * console.log(error.message) // "Queue full"
  * ```
  *
+ * @see {@link isExceededCapacityError} for checking unknown values
+ *
  * @category constructors
  * @since 4.0.0
  */
 export const ExceededCapacityError = effect.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 const AsyncFiberErrorTypeId = effect.AsyncFiberErrorTypeId;
 /**
- * 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
  */
 export const isAsyncFiberError = effect.isAsyncFiberError;
 /**
- * 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 const AsyncFiberError = effect.AsyncFiberError;
 /**
- * Unique brand for {@link UnknownError}.
+ * Unique brand for `UnknownError`.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const UnknownErrorTypeId = effect.UnknownErrorTypeId;
 /**
- * Tests if an arbitrary value is an {@link UnknownError}.
+ * Checks whether an arbitrary value is an `UnknownError`.
  *
  * **Example** (runtime type check)
  *
@@ -1080,7 +1243,7 @@ export const UnknownErrorTypeId = effect.UnknownErrorTypeId;
  */
 export const isUnknownError = effect.isUnknownError;
 /**
- * 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.
  *
@@ -1098,7 +1261,11 @@ export const isUnknownError = effect.isUnknownError;
  */
 export const UnknownError = effect.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**
  *
@@ -1106,7 +1273,7 @@ export const UnknownError = effect.UnknownError;
  * 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.
  *
@@ -1115,48 +1282,88 @@ export const UnknownError = effect.UnknownError;
  * ```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 const annotate = core.causeAnnotate;
 /**
- * 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 const reasonAnnotations = effect.reasonAnnotations;
 /**
- * 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**
  *
- * Annotations from later reasons overwrite earlier ones when keys collide.
+ * 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"
+ *
+ * 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
  */
 export const annotations = effect.causeAnnotations;
 /**
- * `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**
  *
@@ -1164,17 +1371,30 @@ export const annotations = effect.causeAnnotations;
  * 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
  */
 export class StackTrace extends /*#__PURE__*/Context.Service()("effect/Cause/StackTrace") {}
 /**
- * `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