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

package/src/Result.ts

@@ -95,12 +95,6 @@ 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
@@ -121,7 +115,7 @@ 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>
@@ -150,7 +144,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 {
@@ -168,8 +162,11 @@ export interface Failure<out A, out E> extends Pipeable, Inspectable {
 }
 
 /**
+ * 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(
@@ -201,7 +198,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 {
@@ -224,7 +221,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 { [Unify.typeSymbol]?: any }> {
@@ -237,7 +234,7 @@ export interface ResultUnify<T extends { [Unify.typeSymbol]?: any }> {
  * 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 {}
@@ -274,22 +271,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
    */
   export 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
    */
   export type Success<T extends Result<any, any>> = [T] extends [Result<infer _A, infer _E>] ? _A : never
 }
@@ -301,12 +297,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
@@ -321,7 +311,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 const succeed: <A>(right: A) => Result<A> = result.succeed
@@ -333,12 +323,6 @@ export const succeed: <A>(right: A) => Result<A> = result.succeed
  * - 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
@@ -353,7 +337,7 @@ export const succeed: <A>(right: A) => Result<A> = result.succeed
  * @see {@link succeed} to create a Success
  * @see {@link mapError} to transform the error
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const fail: <E>(left: E) => Result<never, E> = result.fail
@@ -379,21 +363,21 @@ 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 const failVoid: Result<never, void> = fail(void 0)
@@ -421,7 +405,7 @@ export const failVoid: Result<never, void> = fail(void 0)
  * @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 const fromNullishOr: {
@@ -448,7 +432,7 @@ export 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>
@@ -475,7 +459,7 @@ export 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>
@@ -509,8 +493,8 @@ export 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 const fromOption: {
   /**
@@ -537,8 +521,8 @@ export 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>
   /**
@@ -565,8 +549,8 @@ export 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>
 } = result.fromOption
@@ -629,8 +613,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
 }
@@ -737,7 +721,7 @@ export const isSuccess: <A, E>(self: Result<A, E>) => self is Success<A, E> = re
  * @see {@link getFailure} to extract the error instead
  * @see {@link fromOption} for the reverse conversion
  *
- * @category Getters
+ * @category getters
  * @since 4.0.0
  */
 export const getSuccess: <A, E>(self: Result<A, E>) => Option<A> = result.getSuccess
@@ -764,7 +748,7 @@ export const getSuccess: <A, E>(self: Result<A, E>) => Option<A> = result.getSuc
  * @see {@link getSuccess} to extract the success instead
  * @see {@link fromOption} for the reverse conversion
  *
- * @category Getters
+ * @category getters
  * @since 4.0.0
  */
 export const getFailure: <A, E>(self: Result<A, E>) => Option<E> = result.getFailure
@@ -834,8 +818,8 @@ export const makeEquivalence = <A, E>(
  * @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 const mapBoth: {
   /**
@@ -866,8 +850,8 @@ export 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: {
@@ -903,8 +887,8 @@ export 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>,
@@ -944,7 +928,7 @@ export 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 const mapError: {
@@ -971,7 +955,7 @@ export 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>
@@ -998,7 +982,7 @@ export 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>
@@ -1033,8 +1017,8 @@ export 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 const map: {
   /**
@@ -1062,8 +1046,8 @@ export 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>
   /**
@@ -1091,8 +1075,8 @@ export 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>
 } = dual(
@@ -1130,7 +1114,7 @@ export 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 const match: {
   /**
@@ -1162,7 +1146,7 @@ export 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: {
@@ -1199,7 +1183,7 @@ export 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>,
@@ -1243,8 +1227,8 @@ export 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 const liftPredicate: {
   /**
@@ -1274,8 +1258,8 @@ export 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>
   /**
@@ -1305,8 +1289,8 @@ export 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>
   /**
@@ -1336,8 +1320,8 @@ export 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>
   /**
@@ -1367,8 +1351,8 @@ export 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>
 } = dual(
@@ -1406,8 +1390,8 @@ export 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 const filterOrFail: {
   /**
@@ -1439,8 +1423,8 @@ export 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>,
@@ -1475,8 +1459,8 @@ export 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>
   /**
@@ -1508,8 +1492,8 @@ export 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>,
@@ -1545,8 +1529,8 @@ export 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>
 } = dual(3, <A, E, E2>(
@@ -1578,8 +1562,8 @@ export 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 const merge: <A, E>(self: Result<A, E>) => E | A = match({ onFailure: identity, onSuccess: identity })
 
@@ -1606,8 +1590,8 @@ export const merge: <A, E>(self: Result<A, E>) => E | A = match({ onFailure: ide
  * @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 const getOrElse: {
   /**
@@ -1633,8 +1617,8 @@ export 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
   /**
@@ -1660,8 +1644,8 @@ export 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
 } = dual(
@@ -1692,8 +1676,8 @@ export 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 const getOrNull: <A, E>(self: Result<A, E>) => A | null = getOrElse(constNull)
 
@@ -1719,8 +1703,8 @@ export const getOrNull: <A, E>(self: Result<A, E>) => A | null = getOrElse(const
  * @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 const getOrUndefined: <A, E>(self: Result<A, E>) => A | undefined = getOrElse(constUndefined)
 
@@ -1752,8 +1736,8 @@ export const getOrUndefined: <A, E>(self: Result<A, E>) => A | undefined = getOr
  * @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 const getOrThrowWith: {
   /**
@@ -1784,8 +1768,8 @@ export 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
   /**
@@ -1816,8 +1800,8 @@ export 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
 } = dual(2, <A, E>(self: Result<A, E>, onFailure: (err: E) => unknown): A => {
@@ -1849,8 +1833,8 @@ export 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 const getOrThrow: <A, E>(self: Result<A, E>) => A = getOrThrowWith(identity)
 
@@ -1878,8 +1862,8 @@ export const getOrThrow: <A, E>(self: Result<A, E>) => A = getOrThrowWith(identi
  * @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 const orElse: {
   /**
@@ -1906,8 +1890,8 @@ export 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>
   /**
@@ -1934,8 +1918,8 @@ export 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>
 } = dual(
@@ -1970,8 +1954,8 @@ export 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 const flatMap: {
   /**
@@ -2000,8 +1984,8 @@ export 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>
   /**
@@ -2030,8 +2014,8 @@ export 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>
 } = dual(
@@ -2077,8 +2061,8 @@ export 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 const andThen: {
   /**
@@ -2118,8 +2102,8 @@ export 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>
   /**
@@ -2159,8 +2143,8 @@ export 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>
   /**
@@ -2200,8 +2184,8 @@ export 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>
   /**
@@ -2241,8 +2225,8 @@ export 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>
   /**
@@ -2282,8 +2266,8 @@ export 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>
   /**
@@ -2323,8 +2307,8 @@ export 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>
   /**
@@ -2364,8 +2348,8 @@ export 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>
   /**
@@ -2405,8 +2389,8 @@ export 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>
 } = dual(
@@ -2450,8 +2434,8 @@ export 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
  */
 // @ts-expect-error
 export const all: <const I extends Iterable<Result<any, any>> | Record<string, Result<any, any>>>(
@@ -2511,8 +2495,8 @@ export const all: <const I extends Iterable<Result<any, any>> | Record<string, R
  *
  * @see {@link mapError} to transform the error without swapping
  *
- * @category Utilities
- * @since 4.0.0
+ * @category utils
+ * @since 2.0.0
  */
 export const flip = <A, E>(self: Result<A, E>): Result<E, A> =>
   isFailure(self) ? succeed(self.failure) : fail(self.success)
@@ -2544,7 +2528,7 @@ export 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 const gen: Gen.Gen<ResultTypeLambda> = (...args) => {
   const f = args.length === 1 ? args[0] : args[1].bind(args[0])
@@ -2591,7 +2575,7 @@ export const gen: Gen.Gen<ResultTypeLambda> = (...args) => {
  * @see {@link gen} for an alternative generator-based syntax
  *
  * @category Do Notation
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const Do: Result<{}> = succeed({})
 
@@ -2622,7 +2606,7 @@ export const Do: Result<{}> = succeed({})
  * @see {@link bindTo} to wrap an initial Result into a named field
  *
  * @category Do Notation
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const bind: {
   /**
@@ -2652,7 +2636,7 @@ export 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 }, L1 | L2>
   /**
@@ -2682,7 +2666,7 @@ export 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>,
@@ -2713,7 +2697,7 @@ export const bind: {
  * @see {@link bind} to add more fields
  *
  * @category Do Notation
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const bindTo: {
   /**
@@ -2738,7 +2722,7 @@ export 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>
   /**
@@ -2763,7 +2747,7 @@ export 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>
 } = doNotation.bindTo<ResultTypeLambda>(map)
@@ -2807,7 +2791,7 @@ export {
    * @see {@link bind} for Result-producing fields
    *
    * @category Do Notation
-   * @since 4.0.0
+   * @since 2.0.0
    */
   let_ as let
 }
@@ -2835,8 +2819,8 @@ export {
  *
  * @see {@link transposeMapOption} to map and transpose in one step
  *
- * @since 3.14.0
  * @category Transposing
+ * @since 3.14.0
  */
 export const transposeOption = <A = never, E = never>(
   self: Option<Result<A, E>>
@@ -2871,8 +2855,8 @@ export const transposeOption = <A = never, E = never>(
  *
  * @see {@link transposeOption} when the Option already contains a Result
  *
- * @since 3.15.0
  * @category Transposing
+ * @since 3.15.0
  */
 export const transposeMapOption = dual<
   /**
@@ -2902,8 +2886,8 @@ export const transposeMapOption = dual<
    *
    * @see {@link transposeOption} when the Option already contains a Result
    *
-   * @since 3.15.0
    * @category Transposing
+   * @since 3.15.0
    */
   <A, B, E = never>(f: (self: A) => Result<B, E>) => (self: Option<A>) => Result<Option<B>, E>,
   /**
@@ -2933,8 +2917,8 @@ export const transposeMapOption = dual<
    *
    * @see {@link transposeOption} when the Option already contains a Result
    *
-   * @since 3.15.0
    * @category Transposing
+   * @since 3.15.0
    */
   <A, B, E = never>(self: Option<A>, f: (self: A) => Result<B, E>) => Result<Option<B>, E>
 >(2, (self, f) => option_.isNone(self) ? succeedNone : map(f(self.value), option_.some))
@@ -2956,7 +2940,7 @@ export const transposeMapOption = dual<
  *
  * @see {@link succeedSome} for the `Some` counterpart
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const succeedNone = succeed(option_.none)
@@ -2979,7 +2963,7 @@ export const succeedNone = succeed(option_.none)
  *
  * @see {@link succeedNone} for the `None` counterpart
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const succeedSome = <A, E = never>(a: A): Result<Option<A>, E> => succeed(option_.some(a))
@@ -3009,7 +2993,7 @@ export const succeedSome = <A, E = never>(a: A): Result<Option<A>, E> => succeed
  *
  * @see {@link map} to transform the success value
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export const tap: {
@@ -3038,7 +3022,7 @@ export 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>
@@ -3067,7 +3051,7 @@ export 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>