effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/Result.d.ts

@@ -87,12 +87,6 @@ declare const TypeId = "~effect/data/Result";
  *
  * `E` defaults to `never`, so `Result<number>` means a result that cannot fail.
  *
- * **Previously Known As**
- *
- * This API replaces the following from Effect 3.x:
- *
- * - `Either`
- *
  * **Example** (Creating and matching a Result)
  *
  * ```ts
@@ -113,7 +107,7 @@ declare const TypeId = "~effect/data/Result";
  * @see {@link match} to fold both branches
  * @see {@link isSuccess} / {@link isFailure} for type guards
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Result<A, E = never> = Success<A, E> | Failure<A, E>;
@@ -141,7 +135,7 @@ export type Result<A, E = never> = Success<A, E> | Failure<A, E>;
  * @see {@link isFailure} to narrow the type
  * @see {@link Success} for the other variant
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Failure<out A, out E> extends Pipeable, Inspectable {
@@ -158,8 +152,11 @@ export interface Failure<out A, out E> extends Pipeable, Inspectable {
     [Unify.ignoreSymbol]?: ResultUnifyIgnore;
 }
 /**
+ * Iterator protocol used to yield a `Result` inside {@link gen}, returning the
+ * success value type back to the generator.
+ *
+ * @category Generators
  * @since 4.0.0
- * @category Models
  */
 export interface ResultIterator<T extends Result<any, any>> {
     next(...args: ReadonlyArray<any>): IteratorResult<T, Result.Success<T>>;
@@ -188,7 +185,7 @@ export interface ResultIterator<T extends Result<any, any>> {
  * @see {@link isSuccess} to narrow the type
  * @see {@link Failure} for the other variant
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Success<out A, out E> extends Pipeable, Inspectable {
@@ -210,7 +207,7 @@ export interface Success<out A, out E> extends Pipeable, Inspectable {
  * This is an internal interface used by the Effect type system. You typically
  * do not need to reference it directly.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ResultUnify<T extends {
@@ -224,7 +221,7 @@ export interface ResultUnify<T extends {
  * This is an internal interface used by the Effect type system. You typically
  * do not need to reference it directly.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ResultUnifyIgnore {
@@ -260,22 +257,21 @@ export interface ResultTypeLambda extends TypeLambda {
  * type E = Result.Result.Failure<R>
  * ```
  *
- * @category Type Level
  * @since 4.0.0
  */
 export declare namespace Result {
     /**
      * Extracts the failure type `E` from `Result<A, E>`.
      *
-     * @since 4.0.0
      * @category Type Level
+     * @since 4.0.0
      */
     type Failure<T extends Result<any, any>> = [T] extends [Result<infer _A, infer _E>] ? _E : never;
     /**
      * Extracts the success type `A` from `Result<A, E>`.
      *
-     * @since 4.0.0
      * @category Type Level
+     * @since 4.0.0
      */
     type Success<T extends Result<any, any>> = [T] extends [Result<infer _A, infer _E>] ? _A : never;
 }
@@ -286,12 +282,6 @@ export declare namespace Result {
  * - The error type `E` defaults to `never`
  * - Does not mutate input; allocates a new `Success` wrapper
  *
- * **Previously Known As**
- *
- * This API replaces the following from Effect 3.x:
- *
- * - `Either.right`
- *
  * **Example** (Wrapping a value)
  *
  * ```ts
@@ -306,7 +296,7 @@ export declare namespace Result {
  * @see {@link fail} to create a Failure
  * @see {@link void} for a pre-built `Success<void>`
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const succeed: <A>(right: A) => Result<A>;
@@ -317,12 +307,6 @@ export declare const succeed: <A>(right: A) => Result<A>;
  * - The success type `A` defaults to `never`
  * - Does not mutate input; allocates a new `Failure` wrapper
  *
- * **Previously Known As**
- *
- * This API replaces the following from Effect 3.x:
- *
- * - `Either.left`
- *
  * **Example** (Creating a failure)
  *
  * ```ts
@@ -337,7 +321,7 @@ export declare const succeed: <A>(right: A) => Result<A>;
  * @see {@link succeed} to create a Success
  * @see {@link mapError} to transform the error
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const fail: <E>(left: E) => Result<never, E>;
@@ -362,19 +346,19 @@ export {
  *
  * @see {@link succeed}
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 3.13.0
  */
 void_ as void };
 /**
- * A pre-built `Result<void>` holding `undefined` as its failure value.
+ * A pre-built failed `Result` whose failure value is `undefined`.
  *
- * - Use when you need a `Result` that represents "failed with no meaningful value"
- * - Equivalent to `Result.fail(undefined)` but avoids an extra allocation
+ * This is equivalent to `Result.fail(undefined)` with type
+ * `Result<never, void>`, but avoids allocating a new `Failure` wrapper.
  *
  * @see {@link fail}
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const failVoid: Result<never, void>;
@@ -401,7 +385,7 @@ export declare const failVoid: Result<never, void>;
  * @see {@link fromOption} to convert from an Option
  * @see {@link succeed} / {@link fail} for direct construction
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const fromNullishOr: {
@@ -428,7 +412,7 @@ export declare const fromNullishOr: {
      * @see {@link fromOption} to convert from an Option
      * @see {@link succeed} / {@link fail} for direct construction
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <A, E>(onNullish: (a: A) => E): (self: A) => Result<NonNullable<A>, E>;
@@ -455,7 +439,7 @@ export declare const fromNullishOr: {
      * @see {@link fromOption} to convert from an Option
      * @see {@link succeed} / {@link fail} for direct construction
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <A, E>(self: A, onNullish: (a: A) => E): Result<NonNullable<A>, E>;
@@ -484,8 +468,8 @@ export declare const fromNullishOr: {
  * @see {@link getSuccess} / {@link getFailure} to convert back to Option
  * @see {@link fromNullishOr} to convert from nullable values
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export declare const fromOption: {
     /**
@@ -512,8 +496,8 @@ export declare const fromOption: {
      * @see {@link getSuccess} / {@link getFailure} to convert back to Option
      * @see {@link fromNullishOr} to convert from nullable values
      *
-     * @category Constructors
-     * @since 4.0.0
+     * @category constructors
+     * @since 2.0.0
      */
     <E>(onNone: () => E): <A>(self: Option<A>) => Result<A, E>;
     /**
@@ -540,8 +524,8 @@ export declare const fromOption: {
      * @see {@link getSuccess} / {@link getFailure} to convert back to Option
      * @see {@link fromNullishOr} to convert from nullable values
      *
-     * @category Constructors
-     * @since 4.0.0
+     * @category constructors
+     * @since 2.0.0
      */
     <A, E>(self: Option<A>, onNone: () => E): Result<A, E>;
 };
@@ -581,8 +565,8 @@ export {
  * @see {@link succeed} / {@link fail} for direct construction
  * @see {@link fromNullishOr} for nullable values
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 try_ as try };
 /**
@@ -684,7 +668,7 @@ export declare const isSuccess: <A, E>(self: Result<A, E>) => self is Success<A,
  * @see {@link getFailure} to extract the error instead
  * @see {@link fromOption} for the reverse conversion
  *
- * @category Getters
+ * @category getters
  * @since 4.0.0
  */
 export declare const getSuccess: <A, E>(self: Result<A, E>) => Option<A>;
@@ -710,7 +694,7 @@ export declare const getSuccess: <A, E>(self: Result<A, E>) => Option<A>;
  * @see {@link getSuccess} to extract the success instead
  * @see {@link fromOption} for the reverse conversion
  *
- * @category Getters
+ * @category getters
  * @since 4.0.0
  */
 export declare const getFailure: <A, E>(self: Result<A, E>) => Option<E>;
@@ -770,8 +754,8 @@ export declare const makeEquivalence: <A, E>(success: Equivalence.Equivalence<A>
  * @see {@link mapError} to transform only the error value
  * @see {@link match} to fold into a single value
  *
- * @category Mapping
- * @since 4.0.0
+ * @category mapping
+ * @since 2.0.0
  */
 export declare const mapBoth: {
     /**
@@ -802,8 +786,8 @@ export declare const mapBoth: {
      * @see {@link mapError} to transform only the error value
      * @see {@link match} to fold into a single value
      *
-     * @category Mapping
-     * @since 4.0.0
+     * @category mapping
+     * @since 2.0.0
      */
     <E, E2, A, A2>(options: {
         readonly onFailure: (left: E) => E2;
@@ -837,8 +821,8 @@ export declare const mapBoth: {
      * @see {@link mapError} to transform only the error value
      * @see {@link match} to fold into a single value
      *
-     * @category Mapping
-     * @since 4.0.0
+     * @category mapping
+     * @since 2.0.0
      */
     <E, A, E2, A2>(self: Result<A, E>, options: {
         readonly onFailure: (left: E) => E2;
@@ -868,7 +852,7 @@ export declare const mapBoth: {
  * @see {@link map} to transform only the success value
  * @see {@link mapBoth} to transform both channels
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export declare const mapError: {
@@ -895,7 +879,7 @@ export declare const mapError: {
      * @see {@link map} to transform only the success value
      * @see {@link mapBoth} to transform both channels
      *
-     * @category Mapping
+     * @category mapping
      * @since 4.0.0
      */
     <E, E2>(f: (err: E) => E2): <A>(self: Result<A, E>) => Result<A, E2>;
@@ -922,7 +906,7 @@ export declare const mapError: {
      * @see {@link map} to transform only the success value
      * @see {@link mapBoth} to transform both channels
      *
-     * @category Mapping
+     * @category mapping
      * @since 4.0.0
      */
     <A, E, E2>(self: Result<A, E>, f: (err: E) => E2): Result<A, E2>;
@@ -952,8 +936,8 @@ export declare const mapError: {
  * @see {@link mapBoth} to transform both channels
  * @see {@link flatMap} when `f` returns a `Result`
  *
- * @category Mapping
- * @since 4.0.0
+ * @category mapping
+ * @since 2.0.0
  */
 export declare const map: {
     /**
@@ -981,8 +965,8 @@ export declare const map: {
      * @see {@link mapBoth} to transform both channels
      * @see {@link flatMap} when `f` returns a `Result`
      *
-     * @category Mapping
-     * @since 4.0.0
+     * @category mapping
+     * @since 2.0.0
      */
     <A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>;
     /**
@@ -1010,8 +994,8 @@ export declare const map: {
      * @see {@link mapBoth} to transform both channels
      * @see {@link flatMap} when `f` returns a `Result`
      *
-     * @category Mapping
-     * @since 4.0.0
+     * @category mapping
+     * @since 2.0.0
      */
     <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>;
 };
@@ -1044,7 +1028,7 @@ export declare const map: {
  * @see {@link getOrElse} to unwrap only the success with a fallback
  *
  * @category Pattern Matching
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const match: {
     /**
@@ -1076,7 +1060,7 @@ export declare const match: {
      * @see {@link getOrElse} to unwrap only the success with a fallback
      *
      * @category Pattern Matching
-     * @since 4.0.0
+     * @since 2.0.0
      */
     <E, B, A, C = B>(options: {
         readonly onFailure: (error: E) => B;
@@ -1111,7 +1095,7 @@ export declare const match: {
      * @see {@link getOrElse} to unwrap only the success with a fallback
      *
      * @category Pattern Matching
-     * @since 4.0.0
+     * @since 2.0.0
      */
     <A, E, B, C = B>(self: Result<A, E>, options: {
         readonly onFailure: (error: E) => B;
@@ -1145,8 +1129,8 @@ export declare const match: {
  * @see {@link filterOrFail} to validate a value that is already in a `Result`
  * @see {@link fromNullishOr} for nullable-based construction
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 3.4.0
  */
 export declare const liftPredicate: {
     /**
@@ -1176,8 +1160,8 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
-     * @category Constructors
-     * @since 4.0.0
+     * @category constructors
+     * @since 3.4.0
      */
     <A, B extends A, E>(refinement: Refinement<A, B>, orFailWith: (a: A) => E): (a: A) => Result<B, E>;
     /**
@@ -1207,8 +1191,8 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
-     * @category Constructors
-     * @since 4.0.0
+     * @category constructors
+     * @since 3.4.0
      */
     <B extends A, E, A = B>(predicate: Predicate<A>, orFailWith: (a: A) => E): (a: B) => Result<B, E>;
     /**
@@ -1238,8 +1222,8 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
-     * @category Constructors
-     * @since 4.0.0
+     * @category constructors
+     * @since 3.4.0
      */
     <A, E, B extends A>(self: A, refinement: Refinement<A, B>, orFailWith: (a: A) => E): Result<B, E>;
     /**
@@ -1269,8 +1253,8 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
-     * @category Constructors
-     * @since 4.0.0
+     * @category constructors
+     * @since 3.4.0
      */
     <B extends A, E, A = B>(self: B, predicate: Predicate<A>, orFailWith: (a: A) => E): Result<B, E>;
 };
@@ -1303,8 +1287,8 @@ export declare const liftPredicate: {
  * @see {@link liftPredicate} to create a `Result` from a raw value with a predicate
  * @see {@link flatMap} for general conditional chaining
  *
+ * @category filtering
  * @since 4.0.0
- * @category Filtering
  */
 export declare const filterOrFail: {
     /**
@@ -1336,8 +1320,8 @@ export declare const filterOrFail: {
      * @see {@link liftPredicate} to create a `Result` from a raw value with a predicate
      * @see {@link flatMap} for general conditional chaining
      *
+     * @category filtering
      * @since 4.0.0
-     * @category Filtering
      */
     <A, B extends A, E2>(refinement: Refinement<NoInfer<A>, B>, orFailWith: (value: NoInfer<A>) => E2): <E>(self: Result<A, E>) => Result<B, E2 | E>;
     /**
@@ -1369,8 +1353,8 @@ export declare const filterOrFail: {
      * @see {@link liftPredicate} to create a `Result` from a raw value with a predicate
      * @see {@link flatMap} for general conditional chaining
      *
+     * @category filtering
      * @since 4.0.0
-     * @category Filtering
      */
     <A, E2>(predicate: Predicate<NoInfer<A>>, orFailWith: (value: NoInfer<A>) => E2): <E>(self: Result<A, E>) => Result<A, E2 | E>;
     /**
@@ -1402,8 +1386,8 @@ export declare const filterOrFail: {
      * @see {@link liftPredicate} to create a `Result` from a raw value with a predicate
      * @see {@link flatMap} for general conditional chaining
      *
+     * @category filtering
      * @since 4.0.0
-     * @category Filtering
      */
     <A, E, B extends A, E2>(self: Result<A, E>, refinement: Refinement<A, B>, orFailWith: (value: A) => E2): Result<B, E | E2>;
     /**
@@ -1435,8 +1419,8 @@ export declare const filterOrFail: {
      * @see {@link liftPredicate} to create a `Result` from a raw value with a predicate
      * @see {@link flatMap} for general conditional chaining
      *
+     * @category filtering
      * @since 4.0.0
-     * @category Filtering
      */
     <A, E, E2>(self: Result<A, E>, predicate: Predicate<A>, orFailWith: (value: A) => E2): Result<A, E | E2>;
 };
@@ -1463,8 +1447,8 @@ export declare const filterOrFail: {
  * @see {@link match} to map each branch to a common type
  * @see {@link getOrElse} to provide a fallback for failures
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export declare const merge: <A, E>(self: Result<A, E>) => E | A;
 /**
@@ -1490,8 +1474,8 @@ export declare const merge: <A, E>(self: Result<A, E>) => E | A;
  * @see {@link getOrThrow} to throw on failure
  * @see {@link match} to map both branches
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export declare const getOrElse: {
     /**
@@ -1517,8 +1501,8 @@ export declare const getOrElse: {
      * @see {@link getOrThrow} to throw on failure
      * @see {@link match} to map both branches
      *
-     * @category Getters
-     * @since 4.0.0
+     * @category getters
+     * @since 2.0.0
      */
     <E, A2>(onFailure: (err: E) => A2): <A>(self: Result<A, E>) => A2 | A;
     /**
@@ -1544,8 +1528,8 @@ export declare const getOrElse: {
      * @see {@link getOrThrow} to throw on failure
      * @see {@link match} to map both branches
      *
-     * @category Getters
-     * @since 4.0.0
+     * @category getters
+     * @since 2.0.0
      */
     <A, E, A2>(self: Result<A, E>, onFailure: (err: E) => A2): A | A2;
 };
@@ -1571,8 +1555,8 @@ export declare const getOrElse: {
  * @see {@link getOrUndefined} to return `undefined` instead
  * @see {@link getOrElse} for a custom fallback
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export declare const getOrNull: <A, E>(self: Result<A, E>) => A | null;
 /**
@@ -1597,8 +1581,8 @@ export declare const getOrNull: <A, E>(self: Result<A, E>) => A | null;
  * @see {@link getOrNull} to return `null` instead
  * @see {@link getOrElse} for a custom fallback
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export declare const getOrUndefined: <A, E>(self: Result<A, E>) => A | undefined;
 /**
@@ -1629,8 +1613,8 @@ export declare const getOrUndefined: <A, E>(self: Result<A, E>) => A | undefined
  * @see {@link getOrThrow} to throw the raw failure value
  * @see {@link getOrElse} for a non-throwing alternative
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export declare const getOrThrowWith: {
     /**
@@ -1661,8 +1645,8 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} to throw the raw failure value
      * @see {@link getOrElse} for a non-throwing alternative
      *
-     * @category Getters
-     * @since 4.0.0
+     * @category getters
+     * @since 2.0.0
      */
     <E>(onFailure: (err: E) => unknown): <A>(self: Result<A, E>) => A;
     /**
@@ -1693,8 +1677,8 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} to throw the raw failure value
      * @see {@link getOrElse} for a non-throwing alternative
      *
-     * @category Getters
-     * @since 4.0.0
+     * @category getters
+     * @since 2.0.0
      */
     <A, E>(self: Result<A, E>, onFailure: (err: E) => unknown): A;
 };
@@ -1720,8 +1704,8 @@ export declare const getOrThrowWith: {
  * @see {@link getOrThrowWith} for custom error mapping
  * @see {@link getOrElse} for a non-throwing alternative
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export declare const getOrThrow: <A, E>(self: Result<A, E>) => A;
 /**
@@ -1748,8 +1732,8 @@ export declare const getOrThrow: <A, E>(self: Result<A, E>) => A;
  * @see {@link getOrElse} to unwrap with a fallback value (not a Result)
  * @see {@link mapError} to transform the error without recovering
  *
- * @category Error Handling
- * @since 4.0.0
+ * @category error handling
+ * @since 2.0.0
  */
 export declare const orElse: {
     /**
@@ -1776,8 +1760,8 @@ export declare const orElse: {
      * @see {@link getOrElse} to unwrap with a fallback value (not a Result)
      * @see {@link mapError} to transform the error without recovering
      *
-     * @category Error Handling
-     * @since 4.0.0
+     * @category error handling
+     * @since 2.0.0
      */
     <E, A2, E2>(that: (err: E) => Result<A2, E2>): <A>(self: Result<A, E>) => Result<A | A2, E2>;
     /**
@@ -1804,8 +1788,8 @@ export declare const orElse: {
      * @see {@link getOrElse} to unwrap with a fallback value (not a Result)
      * @see {@link mapError} to transform the error without recovering
      *
-     * @category Error Handling
-     * @since 4.0.0
+     * @category error handling
+     * @since 2.0.0
      */
     <A, E, A2, E2>(self: Result<A, E>, that: (err: E) => Result<A2, E2>): Result<A | A2, E2>;
 };
@@ -1835,8 +1819,8 @@ export declare const orElse: {
  * @see {@link andThen} for a more flexible variant that also accepts plain values
  * @see {@link map} when `f` does not return a `Result`
  *
- * @category Sequencing
- * @since 4.0.0
+ * @category sequencing
+ * @since 2.0.0
  */
 export declare const flatMap: {
     /**
@@ -1865,8 +1849,8 @@ export declare const flatMap: {
      * @see {@link andThen} for a more flexible variant that also accepts plain values
      * @see {@link map} when `f` does not return a `Result`
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, A2, E2>(f: (a: A) => Result<A2, E2>): <E>(self: Result<A, E>) => Result<A2, E | E2>;
     /**
@@ -1895,8 +1879,8 @@ export declare const flatMap: {
      * @see {@link andThen} for a more flexible variant that also accepts plain values
      * @see {@link map} when `f` does not return a `Result`
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, E, A2, E2>(self: Result<A, E>, f: (a: A) => Result<A2, E2>): Result<A2, E | E2>;
 };
@@ -1937,8 +1921,8 @@ export declare const flatMap: {
  * @see {@link flatMap} for the stricter variant (function returning Result only)
  * @see {@link map} when you always return a plain value
  *
- * @category Sequencing
- * @since 4.0.0
+ * @category sequencing
+ * @since 2.0.0
  */
 export declare const andThen: {
     /**
@@ -1978,8 +1962,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, A2, E2>(f: (a: A) => Result<A2, E2>): <E>(self: Result<A, E>) => Result<A2, E | E2>;
     /**
@@ -2019,8 +2003,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A2, E2>(f: Result<A2, E2>): <A, E>(self: Result<A, E>) => Result<A2, E | E2>;
     /**
@@ -2060,8 +2044,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, A2>(f: (a: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>;
     /**
@@ -2101,8 +2085,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A2>(right: NotFunction<A2>): <A, E>(self: Result<A, E>) => Result<A2, E>;
     /**
@@ -2142,8 +2126,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, E, A2, E2>(self: Result<A, E>, f: (a: A) => Result<A2, E2>): Result<A2, E | E2>;
     /**
@@ -2183,8 +2167,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, E, A2, E2>(self: Result<A, E>, f: Result<A2, E2>): Result<A2, E | E2>;
     /**
@@ -2224,8 +2208,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, E, A2>(self: Result<A, E>, f: (a: A) => A2): Result<A2, E>;
     /**
@@ -2265,8 +2249,8 @@ export declare const andThen: {
      * @see {@link flatMap} for the stricter variant (function returning Result only)
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
-     * @since 4.0.0
+     * @category sequencing
+     * @since 2.0.0
      */
     <A, E, A2>(self: Result<A, E>, f: NotFunction<A2>): Result<A2, E>;
 };
@@ -2299,8 +2283,8 @@ export declare const andThen: {
  * @see {@link flatMap} for chaining two Results sequentially
  * @see {@link gen} for generator-based composition of multiple Results
  *
- * @category Sequencing
- * @since 4.0.0
+ * @category sequencing
+ * @since 2.0.0
  */
 export declare const all: <const I extends Iterable<Result<any, any>> | Record<string, Result<any, any>>>(input: I) => [I] extends [ReadonlyArray<Result<any, any>>] ? Result<{
     -readonly [K in keyof I]: [I[K]] extends [Result<infer R, any>] ? R : never;
@@ -2329,8 +2313,8 @@ export declare const all: <const I extends Iterable<Result<any, any>> | Record<s
  *
  * @see {@link mapError} to transform the error without swapping
  *
- * @category Utilities
- * @since 4.0.0
+ * @category utils
+ * @since 2.0.0
  */
 export declare const flip: <A, E>(self: Result<A, E>) => Result<E, A>;
 /**
@@ -2360,7 +2344,7 @@ export declare const flip: <A, E>(self: Result<A, E>) => Result<E, A>;
  * @see {@link all} to collect multiple independent Results
  *
  * @category Generators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const gen: Gen.Gen<ResultTypeLambda>;
 /**
@@ -2390,7 +2374,7 @@ export declare const gen: Gen.Gen<ResultTypeLambda>;
  * @see {@link gen} for an alternative generator-based syntax
  *
  * @category Do Notation
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const Do: Result<{}>;
 /**
@@ -2420,7 +2404,7 @@ export declare const Do: Result<{}>;
  * @see {@link bindTo} to wrap an initial Result into a named field
  *
  * @category Do Notation
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const bind: {
     /**
@@ -2450,7 +2434,7 @@ export declare const bind: {
      * @see {@link bindTo} to wrap an initial Result into a named field
      *
      * @category Do Notation
-     * @since 4.0.0
+     * @since 2.0.0
      */
     <N extends string, A extends object, B, L2>(name: Exclude<N, keyof A>, f: (a: NoInfer<A>) => Result<B, L2>): <L1>(self: Result<A, L1>) => Result<{
         [K in N | keyof A]: K extends keyof A ? A[K] : B;
@@ -2482,7 +2466,7 @@ export declare const bind: {
      * @see {@link bindTo} to wrap an initial Result into a named field
      *
      * @category Do Notation
-     * @since 4.0.0
+     * @since 2.0.0
      */
     <A extends object, L1, N extends string, B, L2>(self: Result<A, L1>, name: Exclude<N, keyof A>, f: (a: NoInfer<A>) => Result<B, L2>): Result<{
         [K in N | keyof A]: K extends keyof A ? A[K] : B;
@@ -2510,7 +2494,7 @@ export declare const bind: {
  * @see {@link bind} to add more fields
  *
  * @category Do Notation
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const bindTo: {
     /**
@@ -2535,7 +2519,7 @@ export declare const bindTo: {
      * @see {@link bind} to add more fields
      *
      * @category Do Notation
-     * @since 4.0.0
+     * @since 2.0.0
      */
     <N extends string>(name: N): <R, L>(self: Result<R, L>) => Result<Record<N, R>, L>;
     /**
@@ -2560,7 +2544,7 @@ export declare const bindTo: {
      * @see {@link bind} to add more fields
      *
      * @category Do Notation
-     * @since 4.0.0
+     * @since 2.0.0
      */
     <R, L, N extends string>(self: Result<R, L>, name: N): Result<Record<N, R>, L>;
 };
@@ -2599,7 +2583,7 @@ export {
  * @see {@link bind} for Result-producing fields
  *
  * @category Do Notation
- * @since 4.0.0
+ * @since 2.0.0
  */
 let_ as let };
 /**
@@ -2625,8 +2609,8 @@ let_ as let };
  *
  * @see {@link transposeMapOption} to map and transpose in one step
  *
- * @since 3.14.0
  * @category Transposing
+ * @since 3.14.0
  */
 export declare const transposeOption: <A = never, E = never>(self: Option<Result<A, E>>) => Result<Option<A>, E>;
 /**
@@ -2656,8 +2640,8 @@ export declare const transposeOption: <A = never, E = never>(self: Option<Result
  *
  * @see {@link transposeOption} when the Option already contains a Result
  *
- * @since 3.15.0
  * @category Transposing
+ * @since 3.15.0
  */
 export declare const transposeMapOption: (<A, B, E = never>(f: (self: A) => Result<B, E>) => (self: Option<A>) => Result<Option<B>, E>) & (<A, B, E = never>(self: Option<A>, f: (self: A) => Result<B, E>) => Result<Option<B>, E>);
 /**
@@ -2677,7 +2661,7 @@ export declare const transposeMapOption: (<A, B, E = never>(f: (self: A) => Resu
  *
  * @see {@link succeedSome} for the `Some` counterpart
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const succeedNone: Result<Option<never>, never>;
@@ -2699,7 +2683,7 @@ export declare const succeedNone: Result<Option<never>, never>;
  *
  * @see {@link succeedNone} for the `None` counterpart
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const succeedSome: <A, E = never>(a: A) => Result<Option<A>, E>;
@@ -2728,7 +2712,7 @@ export declare const succeedSome: <A, E = never>(a: A) => Result<Option<A>, E>;
  *
  * @see {@link map} to transform the success value
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export declare const tap: {
@@ -2757,7 +2741,7 @@ export declare const tap: {
      *
      * @see {@link map} to transform the success value
      *
-     * @category Mapping
+     * @category mapping
      * @since 4.0.0
      */
     <A>(f: (a: A) => void): <E>(self: Result<A, E>) => Result<A, E>;
@@ -2786,7 +2770,7 @@ export declare const tap: {
      *
      * @see {@link map} to transform the success value
      *
-     * @category Mapping
+     * @category mapping
      * @since 4.0.0
      */
     <A, E>(self: Result<A, E>, f: (a: A) => void): Result<A, E>;