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

package/dist/Result.d.ts

@@ -81,6 +81,8 @@ declare 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
@@ -114,6 +116,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}
@@ -164,6 +168,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}
@@ -204,6 +210,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.
  *
@@ -218,6 +226,8 @@ export interface ResultUnify<T extends {
 /**
  * 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.
  *
@@ -229,6 +239,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.
@@ -278,6 +290,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
@@ -303,6 +317,8 @@ export declare const succeed: <A>(right: A) => Result<A>;
 /**
  * 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
@@ -330,6 +346,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
  *
@@ -353,6 +371,8 @@ void_ as void };
 /**
  * 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.
  *
@@ -365,6 +385,8 @@ export declare const failVoid: Result<never, void>;
 /**
  * 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
@@ -392,6 +414,8 @@ export declare 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
@@ -419,6 +443,8 @@ export declare 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
@@ -447,6 +473,8 @@ export declare 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
@@ -475,6 +503,8 @@ export declare 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
@@ -503,6 +533,8 @@ export declare 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
@@ -540,6 +572,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`
@@ -572,6 +606,8 @@ try_ as try };
 /**
  * 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>`
@@ -597,6 +633,8 @@ export declare const isResult: (input: unknown) => input is Result<unknown, unkn
 /**
  * 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
  *
@@ -623,6 +661,8 @@ export declare const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A,
 /**
  * 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
  *
@@ -649,6 +689,8 @@ export declare const isSuccess: <A, E>(self: Result<A, E>) => self is Success<A,
 /**
  * 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
@@ -675,6 +717,8 @@ export declare const getSuccess: <A, E>(self: Result<A, E>) => Option<A>;
 /**
  * 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
@@ -701,6 +745,8 @@ export declare const getFailure: <A, E>(self: Result<A, E>) => Option<E>;
 /**
  * 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
@@ -729,6 +775,8 @@ export declare const makeEquivalence: <A, E>(success: Equivalence.Equivalence<A>
 /**
  * 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
@@ -761,6 +809,8 @@ export declare 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
@@ -796,6 +846,8 @@ export declare 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
@@ -832,6 +884,8 @@ export declare 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
@@ -859,6 +913,8 @@ export declare 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
@@ -886,6 +942,8 @@ export declare 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
@@ -914,6 +972,8 @@ export declare 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
@@ -943,6 +1003,8 @@ export declare 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
@@ -972,6 +1034,8 @@ export declare 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
@@ -1002,6 +1066,8 @@ export declare 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)
@@ -1034,6 +1100,8 @@ export declare 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)
@@ -1069,6 +1137,8 @@ export declare 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)
@@ -1105,6 +1175,8 @@ export declare 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
@@ -1136,6 +1208,8 @@ export declare 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
@@ -1167,6 +1241,8 @@ export declare 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
@@ -1198,6 +1274,8 @@ export declare 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
@@ -1229,6 +1307,8 @@ export declare 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
@@ -1262,6 +1342,8 @@ export declare 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`
@@ -1295,6 +1377,8 @@ export declare 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`
@@ -1328,6 +1412,8 @@ export declare 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`
@@ -1361,6 +1447,8 @@ export declare 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`
@@ -1394,6 +1482,8 @@ export declare 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`
@@ -1428,6 +1518,8 @@ export declare 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
@@ -1454,6 +1546,8 @@ export declare const merge: <A, E>(self: Result<A, E>) => E | A;
 /**
  * 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)
@@ -1481,6 +1575,8 @@ export declare 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)
@@ -1508,6 +1604,8 @@ export declare 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)
@@ -1536,6 +1634,8 @@ export declare 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
@@ -1562,6 +1662,8 @@ export declare const getOrNull: <A, E>(self: Result<A, E>) => A | null;
 /**
  * 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
@@ -1588,6 +1690,8 @@ export declare const getOrUndefined: <A, E>(self: Result<A, E>) => A | undefined
 /**
  * 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
@@ -1620,6 +1724,8 @@ export declare 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
@@ -1652,6 +1758,8 @@ export declare 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
@@ -1685,6 +1793,8 @@ export declare 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
@@ -1712,6 +1822,8 @@ export declare const getOrThrow: <A, E>(self: Result<A, E>) => A;
  * 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
@@ -1740,6 +1852,8 @@ export declare 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
@@ -1768,6 +1882,8 @@ export declare 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
@@ -1796,6 +1912,8 @@ export declare 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`)
@@ -1826,6 +1944,8 @@ export declare 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`)
@@ -1856,6 +1976,8 @@ export declare 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`)
@@ -1887,6 +2009,8 @@ export declare 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`)
@@ -1928,6 +2052,8 @@ export declare 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`)
@@ -1969,6 +2095,8 @@ export declare 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`)
@@ -2010,6 +2138,8 @@ export declare 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`)
@@ -2051,6 +2181,8 @@ export declare 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`)
@@ -2092,6 +2224,8 @@ export declare 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`)
@@ -2133,6 +2267,8 @@ export declare 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`)
@@ -2174,6 +2310,8 @@ export declare 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`)
@@ -2215,6 +2353,8 @@ export declare 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`)
@@ -2257,6 +2397,8 @@ export declare 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
@@ -2294,6 +2436,8 @@ export declare const all: <const I extends Iterable<Result<any, any>> | Record<s
 /**
  * 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`)
@@ -2320,6 +2464,8 @@ export declare 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`
@@ -2350,6 +2496,8 @@ export declare const gen: Gen.Gen<ResultTypeLambda>;
 /**
  * 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.
@@ -2381,6 +2529,8 @@ export declare const Do: Result<{}>;
  * 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
@@ -2411,6 +2561,8 @@ export declare 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
@@ -2443,6 +2595,8 @@ export declare 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
@@ -2474,8 +2628,12 @@ export declare 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)
  *
@@ -2499,8 +2657,12 @@ export declare const bind: {
 export declare 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)
      *
@@ -2524,8 +2686,12 @@ export declare 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)
      *
@@ -2561,6 +2727,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
  *
@@ -2589,6 +2757,8 @@ let_ as let };
 /**
  * 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)`
@@ -2617,6 +2787,8 @@ export declare const transposeOption: <A = never, E = never>(self: Option<Result
  * 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)`
@@ -2647,6 +2819,8 @@ export declare const transposeMapOption: (<A, B, E = never>(f: (self: A) => Resu
 /**
  * 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
  *
@@ -2668,6 +2842,8 @@ export declare const succeedNone: Result<Option<never>, never>;
 /**
  * Creates a `Result<Option<A>>` that succeeds with `Some(a)`.
  *
+ * **Details**
+ *
  * - Equivalent to `Result.succeed(Option.some(a))`
  * - Useful with {@link transposeOption} patterns
  *
@@ -2690,6 +2866,8 @@ export declare const succeedSome: <A, E = never>(a: A) => Result<Option<A>, E>;
 /**
  * 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)
@@ -2719,6 +2897,8 @@ export declare 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)
@@ -2748,6 +2928,8 @@ export declare 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)