effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/Result.ts

@@ -89,6 +89,8 @@ const TypeId = "~effect/data/Result"
 /**
  * A value that is either `Success<A, E>` or `Failure<A, E>`.
  *
+ * **Details**
+ *
  * - Use {@link succeed} / {@link fail} to construct
  * - Use {@link match} to fold both branches
  * - Use {@link isSuccess} / {@link isFailure} to narrow the type
@@ -123,6 +125,8 @@ export type Result<A, E = never> = Success<A, E> | Failure<A, E>
 /**
  * The failure variant of {@link Result}. Wraps an error of type `E`.
  *
+ * **Details**
+ *
  * - Access the error via the `.failure` property
  * - Use {@link isFailure} to narrow a `Result` to `Failure`
  * - Create with {@link fail}
@@ -177,6 +181,8 @@ export interface ResultIterator<T extends Result<any, any>> {
 /**
  * The success variant of {@link Result}. Wraps a value of type `A`.
  *
+ * **Details**
+ *
  * - Access the value via the `.success` property
  * - Use {@link isSuccess} to narrow a `Result` to `Success`
  * - Create with {@link succeed}
@@ -218,6 +224,8 @@ export interface Success<out A, out E> extends Pipeable, Inspectable {
 /**
  * Type-level utility for unifying `Result` types in generic contexts.
  *
+ * **Details**
+ *
  * This is an internal interface used by the Effect type system. You typically
  * do not need to reference it directly.
  *
@@ -231,6 +239,8 @@ export interface ResultUnify<T extends { [Unify.typeSymbol]?: any }> {
 /**
  * Marker interface for ignoring unification in `Result` types.
  *
+ * **Details**
+ *
  * This is an internal interface used by the Effect type system. You typically
  * do not need to reference it directly.
  *
@@ -242,6 +252,8 @@ export interface ResultUnifyIgnore {}
 /**
  * Higher-kinded type representation for `Result`.
  *
+ * **Details**
+ *
  * Used internally to integrate `Result` with generic type-class utilities
  * (e.g., `map`, `flatMap` abstractions). You typically do not need to
  * reference this directly.
@@ -293,6 +305,8 @@ export declare namespace Result {
 /**
  * Creates a `Result` holding a `Success` value.
  *
+ * **Details**
+ *
  * - Use when you have a value and want to lift it into the `Result` type
  * - The error type `E` defaults to `never`
  * - Does not mutate input; allocates a new `Success` wrapper
@@ -319,6 +333,8 @@ export const succeed: <A>(right: A) => Result<A> = result.succeed
 /**
  * Creates a `Result` holding a `Failure` value.
  *
+ * **Details**
+ *
  * - Use when you want to represent a failed computation
  * - The success type `A` defaults to `never`
  * - Does not mutate input; allocates a new `Failure` wrapper
@@ -347,6 +363,8 @@ export {
   /**
    * A pre-built `Result<void>` holding `undefined` as its success value.
    *
+   * **Details**
+   *
    * - Use when you need a `Result` that represents "completed with no meaningful value"
    * - Equivalent to `Result.succeed(undefined)` but avoids an extra allocation
    *
@@ -372,6 +390,8 @@ export {
 /**
  * A pre-built failed `Result` whose failure value is `undefined`.
  *
+ * **Details**
+ *
  * This is equivalent to `Result.fail(undefined)` with type
  * `Result<never, void>`, but avoids allocating a new `Failure` wrapper.
  *
@@ -385,6 +405,8 @@ export const failVoid: Result<never, void> = fail(void 0)
 /**
  * Converts a possibly `null` or `undefined` value into a `Result`.
  *
+ * **Details**
+ *
  * - Non-nullish values become `Success<NonNullable<A>>`
  * - `null` or `undefined` becomes `Failure<E>` using the provided function
  * - Supports both data-first and data-last (piped) usage
@@ -412,6 +434,8 @@ export const fromNullishOr: {
   /**
    * Converts a possibly `null` or `undefined` value into a `Result`.
    *
+   * **Details**
+   *
    * - Non-nullish values become `Success<NonNullable<A>>`
    * - `null` or `undefined` becomes `Failure<E>` using the provided function
    * - Supports both data-first and data-last (piped) usage
@@ -439,6 +463,8 @@ export const fromNullishOr: {
   /**
    * Converts a possibly `null` or `undefined` value into a `Result`.
    *
+   * **Details**
+   *
    * - Non-nullish values become `Success<NonNullable<A>>`
    * - `null` or `undefined` becomes `Failure<E>` using the provided function
    * - Supports both data-first and data-last (piped) usage
@@ -472,6 +498,8 @@ export const fromNullishOr: {
 /**
  * Converts an `Option<A>` into a `Result<A, E>`.
  *
+ * **Details**
+ *
  * - `Some<A>` becomes `Success<A>`
  * - `None` becomes `Failure<E>` using the provided function
  * - Supports both data-first and data-last (piped) usage
@@ -500,6 +528,8 @@ export const fromOption: {
   /**
    * Converts an `Option<A>` into a `Result<A, E>`.
    *
+   * **Details**
+   *
    * - `Some<A>` becomes `Success<A>`
    * - `None` becomes `Failure<E>` using the provided function
    * - Supports both data-first and data-last (piped) usage
@@ -528,6 +558,8 @@ export const fromOption: {
   /**
    * Converts an `Option<A>` into a `Result<A, E>`.
    *
+   * **Details**
+   *
    * - `Some<A>` becomes `Success<A>`
    * - `None` becomes `Failure<E>` using the provided function
    * - Supports both data-first and data-last (piped) usage
@@ -588,6 +620,8 @@ export {
   /**
    * Wraps a synchronous computation that may throw into a `Result`.
    *
+   * **Details**
+   *
    * - If the function returns normally, the result is `Success<A>`
    * - If the function throws, the exception is caught and becomes `Failure<E>`
    * - With a single function argument, the error type is `unknown`
@@ -622,6 +656,8 @@ export {
 /**
  * Tests whether a value is a `Result` (either `Success` or `Failure`).
  *
+ * **Details**
+ *
  * - Use to validate unknown input before operating on it as a `Result`
  * - Returns `true` for both `Success` and `Failure` variants
  * - Acts as a TypeScript type guard, narrowing to `Result<unknown, unknown>`
@@ -648,6 +684,8 @@ export const isResult: (input: unknown) => input is Result<unknown, unknown> = r
 /**
  * Checks whether a `Result` is a `Failure`.
  *
+ * **Details**
+ *
  * - Acts as a TypeScript type guard, narrowing to `Failure<A, E>`
  * - After narrowing, you can access `.failure` to read the error value
  *
@@ -675,6 +713,8 @@ export const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A, E> = re
 /**
  * Checks whether a `Result` is a `Success`.
  *
+ * **Details**
+ *
  * - Acts as a TypeScript type guard, narrowing to `Success<A, E>`
  * - After narrowing, you can access `.success` to read the value
  *
@@ -702,6 +742,8 @@ export const isSuccess: <A, E>(self: Result<A, E>) => self is Success<A, E> = re
 /**
  * Extracts the success value as an `Option`, discarding the failure.
  *
+ * **Details**
+ *
  * - `Success<A>` becomes `Some<A>`
  * - `Failure<E>` becomes `None`
  * - Use when you only care about the success case and want to discard error info
@@ -729,6 +771,8 @@ export const getSuccess: <A, E>(self: Result<A, E>) => Option<A> = result.getSuc
 /**
  * Extracts the failure value as an `Option`, discarding the success.
  *
+ * **Details**
+ *
  * - `Failure<E>` becomes `Some<E>`
  * - `Success<A>` becomes `None`
  * - Use when you only care about the error case
@@ -756,6 +800,8 @@ export const getFailure: <A, E>(self: Result<A, E>) => Option<E> = result.getFai
 /**
  * Creates an `Equivalence` for comparing two `Result` values.
  *
+ * **Details**
+ *
  * - Two `Success` values are equal when the `success` equivalence says so
  * - Two `Failure` values are equal when the `failure` equivalence says so
  * - A `Success` and a `Failure` are never equal
@@ -793,6 +839,8 @@ export const makeEquivalence = <A, E>(
 /**
  * Transforms both the success and failure channels of a `Result`.
  *
+ * **Details**
+ *
  * - Applies `onSuccess` if the result is a `Success`
  * - Applies `onFailure` if the result is a `Failure`
  * - Returns a new `Result`; does not mutate the input
@@ -825,6 +873,8 @@ export const mapBoth: {
   /**
    * Transforms both the success and failure channels of a `Result`.
    *
+   * **Details**
+   *
    * - Applies `onSuccess` if the result is a `Success`
    * - Applies `onFailure` if the result is a `Failure`
    * - Returns a new `Result`; does not mutate the input
@@ -862,6 +912,8 @@ export const mapBoth: {
   /**
    * Transforms both the success and failure channels of a `Result`.
    *
+   * **Details**
+   *
    * - Applies `onSuccess` if the result is a `Success`
    * - Applies `onFailure` if the result is a `Failure`
    * - Returns a new `Result`; does not mutate the input
@@ -908,6 +960,8 @@ export const mapBoth: {
 /**
  * Transforms the failure channel of a `Result`, leaving the success channel unchanged.
  *
+ * **Details**
+ *
  * - If the result is a `Failure`, applies `f` to the error and returns a new `Failure`
  * - If the result is a `Success`, returns it as-is
  * - Does not mutate the input
@@ -935,6 +989,8 @@ export const mapError: {
   /**
    * Transforms the failure channel of a `Result`, leaving the success channel unchanged.
    *
+   * **Details**
+   *
    * - If the result is a `Failure`, applies `f` to the error and returns a new `Failure`
    * - If the result is a `Success`, returns it as-is
    * - Does not mutate the input
@@ -962,6 +1018,8 @@ export const mapError: {
   /**
    * Transforms the failure channel of a `Result`, leaving the success channel unchanged.
    *
+   * **Details**
+   *
    * - If the result is a `Failure`, applies `f` to the error and returns a new `Failure`
    * - If the result is a `Success`, returns it as-is
    * - Does not mutate the input
@@ -995,6 +1053,8 @@ export const mapError: {
 /**
  * Transforms the success channel of a `Result`, leaving the failure channel unchanged.
  *
+ * **Details**
+ *
  * - If the result is a `Success`, applies `f` to the value and returns a new `Success`
  * - If the result is a `Failure`, returns it as-is
  * - Does not mutate the input
@@ -1024,6 +1084,8 @@ export const map: {
   /**
    * Transforms the success channel of a `Result`, leaving the failure channel unchanged.
    *
+   * **Details**
+   *
    * - If the result is a `Success`, applies `f` to the value and returns a new `Success`
    * - If the result is a `Failure`, returns it as-is
    * - Does not mutate the input
@@ -1053,6 +1115,8 @@ export const map: {
   /**
    * Transforms the success channel of a `Result`, leaving the failure channel unchanged.
    *
+   * **Details**
+   *
    * - If the result is a `Success`, applies `f` to the value and returns a new `Success`
    * - If the result is a `Failure`, returns it as-is
    * - Does not mutate the input
@@ -1088,6 +1152,8 @@ export const map: {
 /**
  * Folds a `Result` into a single value by applying one of two functions.
  *
+ * **Details**
+ *
  * - Applies `onSuccess` if the result is a `Success`
  * - Applies `onFailure` if the result is a `Failure`
  * - Both branches must return the same type (or a common supertype)
@@ -1120,6 +1186,8 @@ export const match: {
   /**
    * Folds a `Result` into a single value by applying one of two functions.
    *
+   * **Details**
+   *
    * - Applies `onSuccess` if the result is a `Success`
    * - Applies `onFailure` if the result is a `Failure`
    * - Both branches must return the same type (or a common supertype)
@@ -1157,6 +1225,8 @@ export const match: {
   /**
    * Folds a `Result` into a single value by applying one of two functions.
    *
+   * **Details**
+   *
    * - Applies `onSuccess` if the result is a `Success`
    * - Applies `onFailure` if the result is a `Failure`
    * - Both branches must return the same type (or a common supertype)
@@ -1203,6 +1273,8 @@ export const match: {
 /**
  * Lifts a value into a `Result` based on a predicate or refinement.
  *
+ * **Details**
+ *
  * - If the predicate returns `true`, the value becomes `Success<A>`
  * - If the predicate returns `false`, `orFailWith` produces the error for `Failure<E>`
  * - Also accepts a `Refinement` to narrow the success type
@@ -1234,6 +1306,8 @@ export const liftPredicate: {
   /**
    * Lifts a value into a `Result` based on a predicate or refinement.
    *
+   * **Details**
+   *
    * - If the predicate returns `true`, the value becomes `Success<A>`
    * - If the predicate returns `false`, `orFailWith` produces the error for `Failure<E>`
    * - Also accepts a `Refinement` to narrow the success type
@@ -1265,6 +1339,8 @@ export const liftPredicate: {
   /**
    * Lifts a value into a `Result` based on a predicate or refinement.
    *
+   * **Details**
+   *
    * - If the predicate returns `true`, the value becomes `Success<A>`
    * - If the predicate returns `false`, `orFailWith` produces the error for `Failure<E>`
    * - Also accepts a `Refinement` to narrow the success type
@@ -1296,6 +1372,8 @@ export const liftPredicate: {
   /**
    * Lifts a value into a `Result` based on a predicate or refinement.
    *
+   * **Details**
+   *
    * - If the predicate returns `true`, the value becomes `Success<A>`
    * - If the predicate returns `false`, `orFailWith` produces the error for `Failure<E>`
    * - Also accepts a `Refinement` to narrow the success type
@@ -1327,6 +1405,8 @@ export const liftPredicate: {
   /**
    * Lifts a value into a `Result` based on a predicate or refinement.
    *
+   * **Details**
+   *
    * - If the predicate returns `true`, the value becomes `Success<A>`
    * - If the predicate returns `false`, `orFailWith` produces the error for `Failure<E>`
    * - Also accepts a `Refinement` to narrow the success type
@@ -1365,6 +1445,8 @@ export const liftPredicate: {
  * Validates the success value of a `Result` using a predicate, failing with a
  * custom error if the predicate returns `false`.
  *
+ * **Details**
+ *
  * - If the result is already a `Failure`, it is returned as-is
  * - If the predicate passes, the `Success` is returned unchanged
  * - If the predicate fails, `orFailWith` produces the error for a new `Failure`
@@ -1398,6 +1480,8 @@ export const filterOrFail: {
    * Validates the success value of a `Result` using a predicate, failing with a
    * custom error if the predicate returns `false`.
    *
+   * **Details**
+   *
    * - If the result is already a `Failure`, it is returned as-is
    * - If the predicate passes, the `Success` is returned unchanged
    * - If the predicate fails, `orFailWith` produces the error for a new `Failure`
@@ -1434,6 +1518,8 @@ export const filterOrFail: {
    * Validates the success value of a `Result` using a predicate, failing with a
    * custom error if the predicate returns `false`.
    *
+   * **Details**
+   *
    * - If the result is already a `Failure`, it is returned as-is
    * - If the predicate passes, the `Success` is returned unchanged
    * - If the predicate fails, `orFailWith` produces the error for a new `Failure`
@@ -1467,6 +1553,8 @@ export const filterOrFail: {
    * Validates the success value of a `Result` using a predicate, failing with a
    * custom error if the predicate returns `false`.
    *
+   * **Details**
+   *
    * - If the result is already a `Failure`, it is returned as-is
    * - If the predicate passes, the `Success` is returned unchanged
    * - If the predicate fails, `orFailWith` produces the error for a new `Failure`
@@ -1504,6 +1592,8 @@ export const filterOrFail: {
    * Validates the success value of a `Result` using a predicate, failing with a
    * custom error if the predicate returns `false`.
    *
+   * **Details**
+   *
    * - If the result is already a `Failure`, it is returned as-is
    * - If the predicate passes, the `Success` is returned unchanged
    * - If the predicate fails, `orFailWith` produces the error for a new `Failure`
@@ -1543,6 +1633,8 @@ export const filterOrFail: {
  * Unwraps a `Result` into `A | E` by returning the inner value regardless
  * of whether it is a success or failure.
  *
+ * **Details**
+ *
  * - `Success<A>` returns `A`
  * - `Failure<E>` returns `E`
  * - Useful when both channels share a compatible type
@@ -1570,6 +1662,8 @@ export const merge: <A, E>(self: Result<A, E>) => E | A = match({ onFailure: ide
 /**
  * Extracts the success value, or computes a fallback from the error.
  *
+ * **Details**
+ *
  * - `Success<A>` returns the inner value
  * - `Failure<E>` applies `onFailure` to the error and returns the result
  * - The return type is `A | A2` (union of both branches)
@@ -1597,6 +1691,8 @@ export const getOrElse: {
   /**
    * Extracts the success value, or computes a fallback from the error.
    *
+   * **Details**
+   *
    * - `Success<A>` returns the inner value
    * - `Failure<E>` applies `onFailure` to the error and returns the result
    * - The return type is `A | A2` (union of both branches)
@@ -1624,6 +1720,8 @@ export const getOrElse: {
   /**
    * Extracts the success value, or computes a fallback from the error.
    *
+   * **Details**
+   *
    * - `Success<A>` returns the inner value
    * - `Failure<E>` applies `onFailure` to the error and returns the result
    * - The return type is `A | A2` (union of both branches)
@@ -1657,6 +1755,8 @@ export const getOrElse: {
 /**
  * Extracts the success value, or returns `null` on failure.
  *
+ * **Details**
+ *
  * - `Success<A>` returns `A`
  * - `Failure<E>` returns `null`
  * - Convenient for interop with APIs that use `null` to represent absence
@@ -1684,6 +1784,8 @@ export const getOrNull: <A, E>(self: Result<A, E>) => A | null = getOrElse(const
 /**
  * Extracts the success value, or returns `undefined` on failure.
  *
+ * **Details**
+ *
  * - `Success<A>` returns `A`
  * - `Failure<E>` returns `undefined`
  * - Convenient for interop with APIs that use `undefined` to represent absence
@@ -1711,6 +1813,8 @@ export const getOrUndefined: <A, E>(self: Result<A, E>) => A | undefined = getOr
 /**
  * Extracts the success value or throws a custom error derived from the failure.
  *
+ * **Details**
+ *
  * - `Success<A>` returns `A`
  * - `Failure<E>` throws the value returned by `onFailure(e)`
  * - Use when you want to convert a `Result` into a thrown exception with a
@@ -1743,6 +1847,8 @@ export const getOrThrowWith: {
   /**
    * Extracts the success value or throws a custom error derived from the failure.
    *
+   * **Details**
+   *
    * - `Success<A>` returns `A`
    * - `Failure<E>` throws the value returned by `onFailure(e)`
    * - Use when you want to convert a `Result` into a thrown exception with a
@@ -1775,6 +1881,8 @@ export const getOrThrowWith: {
   /**
    * Extracts the success value or throws a custom error derived from the failure.
    *
+   * **Details**
+   *
    * - `Success<A>` returns `A`
    * - `Failure<E>` throws the value returned by `onFailure(e)`
    * - Use when you want to convert a `Result` into a thrown exception with a
@@ -1814,6 +1922,8 @@ export const getOrThrowWith: {
 /**
  * Extracts the success value or throws the raw failure value `E`.
  *
+ * **Details**
+ *
  * - `Success<A>` returns `A`
  * - `Failure<E>` throws `E` directly
  * - Use {@link getOrThrowWith} for a custom error object
@@ -1842,6 +1952,8 @@ export const getOrThrow: <A, E>(self: Result<A, E>) => A = getOrThrowWith(identi
  * Returns the original `Result` if it is a `Success`, otherwise applies
  * `that` to the error and returns the resulting `Result`.
  *
+ * **Details**
+ *
  * - `Success<A>` is returned unchanged
  * - `Failure<E>` calls `that(e)` to produce a new `Result`
  * - Use to provide a recovery path or fallback computation on failure
@@ -1870,6 +1982,8 @@ export const orElse: {
    * Returns the original `Result` if it is a `Success`, otherwise applies
    * `that` to the error and returns the resulting `Result`.
    *
+   * **Details**
+   *
    * - `Success<A>` is returned unchanged
    * - `Failure<E>` calls `that(e)` to produce a new `Result`
    * - Use to provide a recovery path or fallback computation on failure
@@ -1898,6 +2012,8 @@ export const orElse: {
    * Returns the original `Result` if it is a `Success`, otherwise applies
    * `that` to the error and returns the resulting `Result`.
    *
+   * **Details**
+   *
    * - `Success<A>` is returned unchanged
    * - `Failure<E>` calls `that(e)` to produce a new `Result`
    * - Use to provide a recovery path or fallback computation on failure
@@ -1931,6 +2047,8 @@ export const orElse: {
 /**
  * Chains a function that returns a `Result` onto a successful value.
  *
+ * **Details**
+ *
  * - If `self` is a `Success`, applies `f` to the value and returns the resulting `Result`
  * - If `self` is a `Failure`, short-circuits and returns it unchanged
  * - The error types are merged into a union (`E | E2`)
@@ -1961,6 +2079,8 @@ export const flatMap: {
   /**
    * Chains a function that returns a `Result` onto a successful value.
    *
+   * **Details**
+   *
    * - If `self` is a `Success`, applies `f` to the value and returns the resulting `Result`
    * - If `self` is a `Failure`, short-circuits and returns it unchanged
    * - The error types are merged into a union (`E | E2`)
@@ -1991,6 +2111,8 @@ export const flatMap: {
   /**
    * Chains a function that returns a `Result` onto a successful value.
    *
+   * **Details**
+   *
    * - If `self` is a `Success`, applies `f` to the value and returns the resulting `Result`
    * - If `self` is a `Failure`, short-circuits and returns it unchanged
    * - The error types are merged into a union (`E | E2`)
@@ -2027,6 +2149,8 @@ export const flatMap: {
 /**
  * A flexible variant of {@link flatMap} that accepts multiple input shapes.
  *
+ * **Details**
+ *
  * The second argument can be:
  * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
  * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2068,6 +2192,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2109,6 +2235,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2150,6 +2278,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2191,6 +2321,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2232,6 +2364,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2273,6 +2407,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2314,6 +2450,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2355,6 +2493,8 @@ export const andThen: {
   /**
    * A flexible variant of {@link flatMap} that accepts multiple input shapes.
    *
+   * **Details**
+   *
    * The second argument can be:
    * - A function `(a: A) => Result<A2, E2>` (same as `flatMap`)
    * - A function `(a: A) => A2` (auto-wrapped in `succeed`)
@@ -2408,6 +2548,8 @@ export const andThen: {
 /**
  * Collects a structure of `Result`s into a single `Result` of collected values.
  *
+ * **Details**
+ *
  * Accepts:
  * - A tuple/array: returns `Result` with a tuple/array of success values
  * - A struct (record): returns `Result` with a struct of success values
@@ -2476,6 +2618,8 @@ export const all: <const I extends Iterable<Result<any, any>> | Record<string, R
 /**
  * Swaps the success and failure channels of a `Result`.
  *
+ * **Details**
+ *
  * - `Success<A>` becomes `Failure<A>` (i.e., `Result<E, A>`)
  * - `Failure<E>` becomes `Success<E>` (i.e., `Result<E, A>`)
  * - Useful when you want to apply success-oriented operations (like `map`)
@@ -2504,6 +2648,8 @@ export const flip = <A, E>(self: Result<A, E>): Result<E, A> =>
 /**
  * Generator-based syntax for composing `Result` values sequentially.
  *
+ * **Details**
+ *
  * - Use `yield*` to unwrap a `Result` inside the generator; if any yielded
  *   `Result` is a `Failure`, the generator short-circuits and returns that failure
  * - The return value of the generator is wrapped in `Success`
@@ -2551,6 +2697,8 @@ export const gen: Gen.Gen<ResultTypeLambda> = (...args) => {
 /**
  * Starting point for the "do notation" simulation with `Result`.
  *
+ * **Details**
+ *
  * Creates a `Result<{}>` (success with an empty object). Use with
  * {@link bind} to add `Result`-producing fields and {@link let_ let}
  * to add pure computed fields.
@@ -2583,6 +2731,8 @@ export const Do: Result<{}> = succeed({})
  * Adds a named field to the do-notation accumulator by running a `Result`-producing
  * function that receives the current accumulated object.
  *
+ * **Details**
+ *
  * - Short-circuits on the first `Failure`
  * - The field name must not collide with existing keys
  * - Use {@link let_ let} for pure (non-Result) computed fields
@@ -2613,6 +2763,8 @@ export const bind: {
    * Adds a named field to the do-notation accumulator by running a `Result`-producing
    * function that receives the current accumulated object.
    *
+   * **Details**
+   *
    * - Short-circuits on the first `Failure`
    * - The field name must not collide with existing keys
    * - Use {@link let_ let} for pure (non-Result) computed fields
@@ -2643,6 +2795,8 @@ export const bind: {
    * Adds a named field to the do-notation accumulator by running a `Result`-producing
    * function that receives the current accumulated object.
    *
+   * **Details**
+   *
    * - Short-circuits on the first `Failure`
    * - The field name must not collide with existing keys
    * - Use {@link let_ let} for pure (non-Result) computed fields
@@ -2677,8 +2831,12 @@ export const bind: {
 
 /**
  * Wraps the success value of a `Result` into a named field, producing a
- * `Result<Record<N, A>>`. This is typically used to start a do-notation
- * chain from an existing `Result`.
+ * `Result<Record<N, A>>`.
+ *
+ * **Details**
+ *
+ * This is typically used to start a do-notation chain from an existing
+ * `Result`.
  *
  * **Example** (Wrapping a value into a named field)
  *
@@ -2702,8 +2860,12 @@ export const bind: {
 export const bindTo: {
   /**
    * Wraps the success value of a `Result` into a named field, producing a
-   * `Result<Record<N, A>>`. This is typically used to start a do-notation
-   * chain from an existing `Result`.
+   * `Result<Record<N, A>>`.
+   *
+   * **Details**
+   *
+   * This is typically used to start a do-notation chain from an existing
+   * `Result`.
    *
    * **Example** (Wrapping a value into a named field)
    *
@@ -2727,8 +2889,12 @@ export const bindTo: {
   <N extends string>(name: N): <R, L>(self: Result<R, L>) => Result<Record<N, R>, L>
   /**
    * Wraps the success value of a `Result` into a named field, producing a
-   * `Result<Record<N, A>>`. This is typically used to start a do-notation
-   * chain from an existing `Result`.
+   * `Result<Record<N, A>>`.
+   *
+   * **Details**
+   *
+   * This is typically used to start a do-notation chain from an existing
+   * `Result`.
    *
    * **Example** (Wrapping a value into a named field)
    *
@@ -2769,6 +2935,8 @@ export {
    * Adds a named field to the do-notation accumulator by computing a pure
    * (non-Result) value from the current accumulated object.
    *
+   * **Details**
+   *
    * - Use {@link bind} when the computation returns a `Result`
    * - The field name must not collide with existing keys
    *
@@ -2799,6 +2967,8 @@ export {
 /**
  * Transforms `Option<Result<A, E>>` into `Result<Option<A>, E>`.
  *
+ * **Details**
+ *
  * - `None` becomes `Success(None)`
  * - `Some(Success(a))` becomes `Success(Some(a))`
  * - `Some(Failure(e))` becomes `Failure(e)`
@@ -2832,6 +3002,8 @@ export const transposeOption = <A = never, E = never>(
  * Maps an `Option` value with a `Result`-producing function, then transposes
  * the structure from `Option<Result<B, E>>` to `Result<Option<B>, E>`.
  *
+ * **Details**
+ *
  * - `None` becomes `Success(None)` (the function is never called)
  * - `Some(a)` where `f(a)` is `Success(b)` becomes `Success(Some(b))`
  * - `Some(a)` where `f(a)` is `Failure(e)` becomes `Failure(e)`
@@ -2863,6 +3035,8 @@ export const transposeMapOption = dual<
    * Maps an `Option` value with a `Result`-producing function, then transposes
    * the structure from `Option<Result<B, E>>` to `Result<Option<B>, E>`.
    *
+   * **Details**
+   *
    * - `None` becomes `Success(None)` (the function is never called)
    * - `Some(a)` where `f(a)` is `Success(b)` becomes `Success(Some(b))`
    * - `Some(a)` where `f(a)` is `Failure(e)` becomes `Failure(e)`
@@ -2894,6 +3068,8 @@ export const transposeMapOption = dual<
    * Maps an `Option` value with a `Result`-producing function, then transposes
    * the structure from `Option<Result<B, E>>` to `Result<Option<B>, E>`.
    *
+   * **Details**
+   *
    * - `None` becomes `Success(None)` (the function is never called)
    * - `Some(a)` where `f(a)` is `Success(b)` becomes `Success(Some(b))`
    * - `Some(a)` where `f(a)` is `Failure(e)` becomes `Failure(e)`
@@ -2926,6 +3102,8 @@ export const transposeMapOption = dual<
 /**
  * A pre-built `Result<Option<never>>` that succeeds with `None`.
  *
+ * **Details**
+ *
  * - Equivalent to `Result.succeed(Option.none())` but avoids an extra allocation
  * - Useful with {@link transposeOption} patterns
  *
@@ -2948,6 +3126,8 @@ export const succeedNone = succeed(option_.none)
 /**
  * Creates a `Result<Option<A>>` that succeeds with `Some(a)`.
  *
+ * **Details**
+ *
  * - Equivalent to `Result.succeed(Option.some(a))`
  * - Useful with {@link transposeOption} patterns
  *
@@ -2971,6 +3151,8 @@ export const succeedSome = <A, E = never>(a: A): Result<Option<A>, E> => succeed
 /**
  * Runs a side-effect on the success value without altering the `Result`.
  *
+ * **Details**
+ *
  * - If the result is a `Success`, calls `f` with the value (return value is ignored)
  * - If the result is a `Failure`, `f` is not called
  * - Returns the original `Result` unchanged (same reference)
@@ -3000,6 +3182,8 @@ export const tap: {
   /**
    * Runs a side-effect on the success value without altering the `Result`.
    *
+   * **Details**
+   *
    * - If the result is a `Success`, calls `f` with the value (return value is ignored)
    * - If the result is a `Failure`, `f` is not called
    * - Returns the original `Result` unchanged (same reference)
@@ -3029,6 +3213,8 @@ export const tap: {
   /**
    * Runs a side-effect on the success value without altering the `Result`.
    *
+   * **Details**
+   *
    * - If the result is a `Success`, calls `f` with the value (return value is ignored)
    * - If the result is a `Failure`, `f` is not called
    * - Returns the original `Result` unchanged (same reference)