effect 4.0.1 → 4.0.2

package/dist/Result.d.ts

@@ -7,6 +7,7 @@
  * for creating, checking, mapping, combining, and extracting results, plus
  * conversions to and from `Option` and nullable values.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as Equivalence from "./Equivalence.ts";
@@ -51,6 +52,7 @@ declare const TypeId = "~effect/Result";
  * @see {@link match} to fold both branches
  * @see {@link isSuccess} / {@link isFailure} for type guards
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -80,6 +82,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
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -107,6 +110,7 @@ export interface Failure<out A, out E> extends Pipeable, Inspectable {
  *
  * @see {@link gen} for writing generator-based `Result` code that consumes this iterator protocol
  *
+ * @stability stable
  * @category generators
  * @since 4.0.0
  */
@@ -138,6 +142,7 @@ export interface ResultIterator<T extends Result<any, any>> {
  * @see {@link isSuccess} to narrow the type
  * @see {@link Failure} for the other variant
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -162,6 +167,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.
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -178,6 +184,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.
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -192,6 +199,7 @@ export interface ResultUnifyIgnore {
  * (e.g., `map`, `flatMap` abstractions). You typically do not need to
  * reference this directly.
  *
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -219,6 +227,7 @@ export interface ResultTypeLambda extends TypeLambda {
  * const failure: E = "error"
  * ```
  *
+ * @stability stable
  * @since 4.0.0
  */
 export declare namespace Result {
@@ -256,6 +265,7 @@ export declare namespace Result {
  * @see {@link fail} to create a Failure
  * @see {@link void_ void} for a pre-built `Success<void>`
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -282,6 +292,7 @@ export declare const succeed: <A>(right: A) => Result<A>;
  * @see {@link succeed} to create a Success
  * @see {@link mapError} to transform the error
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -311,6 +322,7 @@ export {
  *
  * @see {@link succeed} to create a Success with a specific value
  *
+ * @stability stable
  * @category constructors
  * @since 3.13.0
  */
@@ -339,6 +351,7 @@ void_ as void };
  *
  * @see {@link fail} to create a Failure with a specific value
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -371,6 +384,7 @@ export declare const failVoid: Result<never, void>;
  * @see {@link fromOption} to convert from an Option
  * @see {@link succeed} / {@link fail} for direct construction
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -403,6 +417,7 @@ export declare const fromNullishOr: {
      * @see {@link fromOption} to convert from an Option
      * @see {@link succeed} / {@link fail} for direct construction
      *
+     * @stability stable
      * @category constructors
      * @since 4.0.0
      */
@@ -435,6 +450,7 @@ export declare const fromNullishOr: {
      * @see {@link fromOption} to convert from an Option
      * @see {@link succeed} / {@link fail} for direct construction
      *
+     * @stability stable
      * @category constructors
      * @since 4.0.0
      */
@@ -468,6 +484,7 @@ export declare const fromNullishOr: {
  * @see {@link getFailure} to extract the failure value as an Option
  * @see {@link fromNullishOr} to build a Result from nullable values
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -500,6 +517,7 @@ export declare const fromOption: {
      * @see {@link getFailure} to extract the failure value as an Option
      * @see {@link fromNullishOr} to build a Result from nullable values
      *
+     * @stability stable
      * @category constructors
      * @since 2.0.0
      */
@@ -532,6 +550,7 @@ export declare const fromOption: {
      * @see {@link getFailure} to extract the failure value as an Option
      * @see {@link fromNullishOr} to build a Result from nullable values
      *
+     * @stability stable
      * @category constructors
      * @since 2.0.0
      */
@@ -572,6 +591,7 @@ export {
  * @see {@link succeed} / {@link fail} for direct construction
  * @see {@link fromNullishOr} for nullable values
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -600,6 +620,7 @@ try_ as try };
  *
  * @see {@link isSuccess} / {@link isFailure} to narrow to a specific variant
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -631,6 +652,7 @@ export declare const isResult: (input: unknown) => input is Result<unknown, unkn
  * @see {@link isSuccess} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -662,6 +684,7 @@ export declare const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A,
  * @see {@link isFailure} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -692,6 +715,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
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */
@@ -722,6 +746,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
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */
@@ -750,6 +775,7 @@ export declare const getFailure: <A, E>(self: Result<A, E>) => Option<E>;
  * eq(Result.succeed(1), Result.fail("x")) // => false
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 4.0.0
  */
@@ -785,6 +811,7 @@ 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
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -820,6 +847,7 @@ export declare const mapBoth: {
      * @see {@link mapError} to transform only the error value
      * @see {@link match} to fold into a single value
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -858,6 +886,7 @@ export declare const mapBoth: {
      * @see {@link mapError} to transform only the error value
      * @see {@link match} to fold into a single value
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -892,6 +921,7 @@ export declare const mapBoth: {
  * @see {@link map} to transform only the success value
  * @see {@link mapBoth} to transform both channels
  *
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -922,6 +952,7 @@ export declare const mapError: {
      * @see {@link map} to transform only the success value
      * @see {@link mapBoth} to transform both channels
      *
+     * @stability stable
      * @category mapping
      * @since 4.0.0
      */
@@ -952,6 +983,7 @@ export declare const mapError: {
      * @see {@link map} to transform only the success value
      * @see {@link mapBoth} to transform both channels
      *
+     * @stability stable
      * @category mapping
      * @since 4.0.0
      */
@@ -986,6 +1018,7 @@ export declare const mapError: {
  * @see {@link mapBoth} to transform both channels
  * @see {@link flatMap} when `f` returns a `Result`
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1019,6 +1052,7 @@ export declare const map: {
      * @see {@link mapBoth} to transform both channels
      * @see {@link flatMap} when `f` returns a `Result`
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1052,6 +1086,7 @@ export declare const map: {
      * @see {@link mapBoth} to transform both channels
      * @see {@link flatMap} when `f` returns a `Result`
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1089,6 +1124,7 @@ export declare const map: {
  * @see {@link merge} to extract `A | E` without mapping
  * @see {@link getOrElse} to unwrap only the success with a fallback
  *
+ * @stability stable
  * @category pattern matching
  * @since 2.0.0
  */
@@ -1125,6 +1161,7 @@ export declare const match: {
      * @see {@link merge} to extract `A | E` without mapping
      * @see {@link getOrElse} to unwrap only the success with a fallback
      *
+     * @stability stable
      * @category pattern matching
      * @since 2.0.0
      */
@@ -1164,6 +1201,7 @@ export declare const match: {
      * @see {@link merge} to extract `A | E` without mapping
      * @see {@link getOrElse} to unwrap only the success with a fallback
      *
+     * @stability stable
      * @category pattern matching
      * @since 2.0.0
      */
@@ -1204,6 +1242,7 @@ export declare const match: {
  * @see {@link filterOrFail} to validate a value that is already in a `Result`
  * @see {@link fromNullishOr} for nullable-based construction
  *
+ * @stability stable
  * @category constructors
  * @since 3.4.0
  */
@@ -1240,6 +1279,7 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
+     * @stability stable
      * @category constructors
      * @since 3.4.0
      */
@@ -1276,6 +1316,7 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
+     * @stability stable
      * @category constructors
      * @since 3.4.0
      */
@@ -1312,6 +1353,7 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
+     * @stability stable
      * @category constructors
      * @since 3.4.0
      */
@@ -1348,6 +1390,7 @@ export declare const liftPredicate: {
      * @see {@link filterOrFail} to validate a value that is already in a `Result`
      * @see {@link fromNullishOr} for nullable-based construction
      *
+     * @stability stable
      * @category constructors
      * @since 3.4.0
      */
@@ -1387,6 +1430,7 @@ 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
  *
+ * @stability stable
  * @category filtering
  * @since 4.0.0
  */
@@ -1425,6 +1469,7 @@ 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
      *
+     * @stability stable
      * @category filtering
      * @since 4.0.0
      */
@@ -1463,6 +1508,7 @@ 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
      *
+     * @stability stable
      * @category filtering
      * @since 4.0.0
      */
@@ -1501,6 +1547,7 @@ 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
      *
+     * @stability stable
      * @category filtering
      * @since 4.0.0
      */
@@ -1539,6 +1586,7 @@ 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
      *
+     * @stability stable
      * @category filtering
      * @since 4.0.0
      */
@@ -1567,6 +1615,7 @@ export declare const filterOrFail: {
  * @see {@link match} to map each branch to a common type
  * @see {@link getOrElse} to provide a fallback for failures
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1600,6 +1649,7 @@ export declare const merge: <A, E>(self: Result<A, E>) => E | A;
  * @see {@link match} to map both branches
  * @see {@link orElse} to recover with another Result instead of unwrapping
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1633,6 +1683,7 @@ export declare const getOrElse: {
      * @see {@link match} to map both branches
      * @see {@link orElse} to recover with another Result instead of unwrapping
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -1666,6 +1717,7 @@ export declare const getOrElse: {
      * @see {@link match} to map both branches
      * @see {@link orElse} to recover with another Result instead of unwrapping
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -1697,6 +1749,7 @@ export declare const getOrElse: {
  * @see {@link getOrUndefined} to return `undefined` instead
  * @see {@link getOrElse} for a custom fallback
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1727,6 +1780,7 @@ 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
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1764,6 +1818,7 @@ 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
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1801,6 +1856,7 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} to throw the raw failure value
      * @see {@link getOrElse} for a non-throwing alternative
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -1838,6 +1894,7 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} to throw the raw failure value
      * @see {@link getOrElse} for a non-throwing alternative
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -1870,6 +1927,7 @@ export declare const getOrThrowWith: {
  * @see {@link getOrThrowWith} for custom error mapping
  * @see {@link getOrElse} for a non-throwing alternative
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1902,6 +1960,7 @@ 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
  *
+ * @stability stable
  * @category error handling
  * @since 2.0.0
  */
@@ -1934,6 +1993,7 @@ 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
      *
+     * @stability stable
      * @category error handling
      * @since 2.0.0
      */
@@ -1966,6 +2026,7 @@ 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
      *
+     * @stability stable
      * @category error handling
      * @since 2.0.0
      */
@@ -2002,6 +2063,7 @@ 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`
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2037,6 +2099,7 @@ 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`
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2072,6 +2135,7 @@ 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`
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2119,6 +2183,7 @@ 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
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2165,6 +2230,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2211,6 +2277,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2257,6 +2324,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2303,6 +2371,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2349,6 +2418,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2395,6 +2465,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2441,6 +2512,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2487,6 +2559,7 @@ 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
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2524,6 +2597,7 @@ export declare const andThen: {
  * @see {@link flatMap} for chaining two Results sequentially
  * @see {@link gen} for generator-based composition of multiple Results
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2559,6 +2633,7 @@ export declare const all: <const I extends Iterable<Result<any, any>> | Record<s
  *
  * @see {@link mapError} to transform the error without swapping
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -2593,6 +2668,7 @@ export declare const flip: <A, E>(self: Result<A, E>) => Result<E, A>;
  * @see {@link flatMap} for point-free sequential composition
  * @see {@link all} to collect multiple independent Results
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -2630,6 +2706,7 @@ export declare const gen: Gen.Gen<ResultTypeLambda>;
  * @see {@link gen} for an alternative generator-based syntax
  * @see {@link bindTo} for starting a do-notation chain from an existing Result
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -2666,6 +2743,7 @@ export declare const Do: Result<{}>;
  * @see {@link let_ let} for pure computed fields
  * @see {@link bindTo} to wrap an initial Result into a named field
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2702,6 +2780,7 @@ export declare const bind: {
      * @see {@link let_ let} for pure computed fields
      * @see {@link bindTo} to wrap an initial Result into a named field
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2740,6 +2819,7 @@ export declare const bind: {
      * @see {@link let_ let} for pure computed fields
      * @see {@link bindTo} to wrap an initial Result into a named field
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2775,6 +2855,7 @@ export declare const bind: {
  * @see {@link Do} to start from an empty object
  * @see {@link bind} to add more fields
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -2807,6 +2888,7 @@ export declare const bindTo: {
      * @see {@link Do} to start from an empty object
      * @see {@link bind} to add more fields
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -2839,6 +2921,7 @@ export declare const bindTo: {
      * @see {@link Do} to start from an empty object
      * @see {@link bind} to add more fields
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -2883,6 +2966,7 @@ export {
  * @see {@link Do} to start the do-notation chain
  * @see {@link bind} for Result-producing fields
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -2913,6 +2997,7 @@ let_ as let };
  *
  * @see {@link transposeMapOption} to map and transpose in one step
  *
+ * @stability stable
  * @category transposing
  * @since 3.14.0
  */
@@ -2949,6 +3034,7 @@ export declare const transposeOption: <A = never, E = never>(self: Option<Result
  *
  * @see {@link transposeOption} when the Option already contains a Result
  *
+ * @stability stable
  * @category transposing
  * @since 3.15.0
  */
@@ -2978,6 +3064,7 @@ export declare const transposeMapOption: (<A, B, E = never>(f: (self: A) => Resu
  * @see {@link transposeOption} to transpose an Option that already contains a Result
  * @see {@link transposeMapOption} to map and transpose an Option in one step
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -3000,6 +3087,7 @@ export declare const succeedNone: Result<Option<never>, never>;
  *
  * @see {@link succeedNone} for the `None` counterpart
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -3031,6 +3119,7 @@ export declare const succeedSome: <A, E = never>(a: A) => Result<Option<A>, E>;
  *
  * @see {@link map} to transform the success value
  *
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -3062,6 +3151,7 @@ export declare const tap: {
      *
      * @see {@link map} to transform the success value
      *
+     * @stability stable
      * @category mapping
      * @since 4.0.0
      */
@@ -3093,6 +3183,7 @@ export declare const tap: {
      *
      * @see {@link map} to transform the success value
      *
+     * @stability stable
      * @category mapping
      * @since 4.0.0
      */