effect 4.0.0 → 4.0.2

package/dist/Option.d.ts

@@ -8,6 +8,7 @@
  * and from common nullable or result-like shapes. It also includes `Option.gen`
  * for writing small generator-based computations that stop at the first `None`.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Combiner from "./Combiner.ts";
@@ -39,6 +40,7 @@ declare const TypeId = "~effect/Option";
  * @see {@link none} for creating a `None`
  * @see {@link match} for pattern matching
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -58,6 +60,7 @@ export type Option<A> = None<A> | Some<A>;
  * @see {@link isNone} to check if an `Option` is `None`
  * @see {@link none} to construct a `None`
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -84,6 +87,7 @@ export interface None<out A> extends Pipeable, Inspectable {
  *
  * @see {@link gen} for writing generator-based `Option` code that consumes this iterator protocol
  *
+ * @stability stable
  * @category generators
  * @since 4.0.0
  */
@@ -107,6 +111,7 @@ export interface OptionIterator<T extends Option<any>> {
  * @see {@link isSome} to check if an `Option` is `Some`
  * @see {@link some} to construct a `Some`
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -136,6 +141,7 @@ export interface Some<out A> extends Pipeable, Inspectable {
  * type when generic code returns or combines `Option` values. Users normally
  * do not need to reference this interface directly.
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -151,6 +157,7 @@ export interface OptionUnify<A extends {
  *
  * Use to access type-level helpers associated with `Option`.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Option {
@@ -189,6 +196,7 @@ export declare namespace Option {
  * This supports type-level unification behavior for `Option`. Users normally
  * do not need to reference this interface directly.
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -202,6 +210,7 @@ export interface OptionUnifyIgnore {
  * Use when defining higher-kinded abstractions that must accept optional-value
  * types as one of their type-lambda inputs.
  *
+ * @stability stable
  * @category utility types
  * @since 2.0.0
  */
@@ -233,6 +242,7 @@ export interface OptionTypeLambda extends TypeLambda {
  *
  * @see {@link some} for the opposite operation.
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -262,6 +272,7 @@ export declare const none: <A = never>() => Option<A>;
  *
  * @see {@link none} for the opposite operation.
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -292,6 +303,7 @@ export declare const some: <A>(value: A) => Option<A>;
  * @see {@link isNone} to check for `None` specifically
  * @see {@link isSome} to check for `Some` specifically
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -318,6 +330,7 @@ export declare const isOption: (input: unknown) => input is Option<unknown>;
  *
  * @see {@link isSome} for the opposite check.
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -344,6 +357,7 @@ export declare const isNone: <A>(self: Option<A>) => self is None<A>;
  *
  * @see {@link isNone} for the opposite check.
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -375,6 +389,7 @@ export declare const isSome: <A>(self: Option<A>) => self is Some<A>;
  *
  * @see {@link getOrElse} for unwrapping with a default
  *
+ * @stability stable
  * @category pattern matching
  * @since 2.0.0
  */
@@ -406,6 +421,7 @@ export declare const match: {
      *
      * @see {@link getOrElse} for unwrapping with a default
      *
+     * @stability stable
      * @category pattern matching
      * @since 2.0.0
      */
@@ -440,6 +456,7 @@ export declare const match: {
      *
      * @see {@link getOrElse} for unwrapping with a default
      *
+     * @stability stable
      * @category pattern matching
      * @since 2.0.0
      */
@@ -482,6 +499,7 @@ export declare const match: {
  *
  * @see {@link liftPredicate} for the reverse direction
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -511,6 +529,7 @@ export declare const toRefinement: <A, B extends A>(f: (a: A) => Option<B>) => (
  *
  * @see {@link toArray} for the inverse direction
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -539,6 +558,7 @@ export declare const fromIterable: <A>(collection: Iterable<A>) => Option<A>;
  *
  * @see {@link getFailure} for the opposite operation.
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -567,6 +587,7 @@ export declare const getSuccess: <A, E>(self: Result<A, E>) => Option<A>;
  *
  * @see {@link getSuccess} for the opposite operation.
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -598,6 +619,7 @@ export declare const getFailure: <A, E>(self: Result<A, E>) => Option<E>;
  * @see {@link getOrUndefined} to fall back to `undefined`
  * @see {@link getOrThrow} to throw on `None`
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -629,6 +651,7 @@ export declare const getOrElse: {
      * @see {@link getOrUndefined} to fall back to `undefined`
      * @see {@link getOrThrow} to throw on `None`
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -660,6 +683,7 @@ export declare const getOrElse: {
      * @see {@link getOrUndefined} to fall back to `undefined`
      * @see {@link getOrThrow} to throw on `None`
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -691,6 +715,7 @@ export declare const getOrElse: {
  * @see {@link orElseSome} to wrap the fallback value in `Some` automatically
  * @see {@link firstSomeOf} to pick the first `Some` from a collection
  *
+ * @stability stable
  * @category error handling
  * @since 2.0.0
  */
@@ -721,6 +746,7 @@ export declare const orElse: {
      * @see {@link orElseSome} to wrap the fallback value in `Some` automatically
      * @see {@link firstSomeOf} to pick the first `Some` from a collection
      *
+     * @stability stable
      * @category error handling
      * @since 2.0.0
      */
@@ -751,6 +777,7 @@ export declare const orElse: {
      * @see {@link orElseSome} to wrap the fallback value in `Some` automatically
      * @see {@link firstSomeOf} to pick the first `Some` from a collection
      *
+     * @stability stable
      * @category error handling
      * @since 2.0.0
      */
@@ -780,6 +807,7 @@ export declare const orElse: {
  *
  * @see {@link orElse} when the fallback is itself an `Option`
  *
+ * @stability stable
  * @category error handling
  * @since 2.0.0
  */
@@ -808,6 +836,7 @@ export declare const orElseSome: {
      *
      * @see {@link orElse} when the fallback is itself an `Option`
      *
+     * @stability stable
      * @category error handling
      * @since 2.0.0
      */
@@ -836,6 +865,7 @@ export declare const orElseSome: {
      *
      * @see {@link orElse} when the fallback is itself an `Option`
      *
+     * @stability stable
      * @category error handling
      * @since 2.0.0
      */
@@ -868,6 +898,7 @@ export declare const orElseSome: {
  *
  * @see {@link orElse} for the simpler variant without source tracking
  *
+ * @stability stable
  * @category error handling
  * @since 4.0.0
  */
@@ -899,6 +930,7 @@ export declare const orElseResult: {
      *
      * @see {@link orElse} for the simpler variant without source tracking
      *
+     * @stability stable
      * @category error handling
      * @since 4.0.0
      */
@@ -930,6 +962,7 @@ export declare const orElseResult: {
      *
      * @see {@link orElse} for the simpler variant without source tracking
      *
+     * @stability stable
      * @category error handling
      * @since 4.0.0
      */
@@ -962,6 +995,7 @@ export declare const orElseResult: {
  *
  * @see {@link orElse} for a two-option fallback
  *
+ * @stability stable
  * @category error handling
  * @since 2.0.0
  */
@@ -993,6 +1027,7 @@ export declare const firstSomeOf: <T, C extends Iterable<Option<T>> = Iterable<O
  * @see {@link fromUndefinedOr} to only treat `undefined` as absent
  * @see {@link liftNullishOr} to lift a nullable-returning function
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1024,6 +1059,7 @@ export declare const fromNullishOr: <A>(a: A) => Option<NonNullable<A>>;
  * @see {@link fromNullishOr} to treat both `null` and `undefined` as absent
  * @see {@link fromNullOr} to only treat `null` as absent
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1055,6 +1091,7 @@ export declare const fromUndefinedOr: <A>(a: A) => Option<Exclude<A, undefined>>
  * @see {@link fromNullishOr} to treat both `null` and `undefined` as absent
  * @see {@link fromUndefinedOr} to only treat `undefined` as absent
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1091,6 +1128,7 @@ export declare const fromNullOr: <A>(a: A) => Option<Exclude<A, null>>;
  * @see {@link fromNullishOr} for converting a single value
  * @see {@link liftThrowable} for functions that throw instead
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1119,6 +1157,7 @@ export declare const liftNullishOr: <A extends ReadonlyArray<unknown>, B>(f: (..
  * @see {@link getOrUndefined} to return `undefined` instead
  * @see {@link getOrElse} for a custom fallback
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1148,6 +1187,7 @@ export declare const getOrNull: <A>(self: Option<A>) => A | null;
  * @see {@link getOrNull} to return `null` instead
  * @see {@link getOrElse} for a custom fallback
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1177,6 +1217,7 @@ export declare const getOrUndefined: <A>(self: Option<A>) => A | undefined;
  *
  * @see {@link liftNullishOr} for nullable-returning functions
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -1211,6 +1252,7 @@ export declare const liftThrowable: <A extends ReadonlyArray<unknown>, B>(f: (..
  * @see {@link getOrThrow} for a version with a default error
  * @see {@link getOrElse} for a non-throwing alternative
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -1245,6 +1287,7 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} for a version with a default error
      * @see {@link getOrElse} for a non-throwing alternative
      *
+     * @stability stable
      * @category converting
      * @since 2.0.0
      */
@@ -1279,6 +1322,7 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} for a version with a default error
      * @see {@link getOrElse} for a non-throwing alternative
      *
+     * @stability stable
      * @category converting
      * @since 2.0.0
      */
@@ -1314,6 +1358,7 @@ export declare const getOrThrowWith: {
  * @see {@link getOrThrowWith} for a custom error
  * @see {@link getOrElse} for a non-throwing alternative
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -1344,6 +1389,7 @@ export declare const getOrThrow: <A>(self: Option<A>) => A;
  * @see {@link flatMap} when `f` returns an `Option`
  * @see {@link as} to replace the value with a constant
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1374,6 +1420,7 @@ export declare const map: {
      * @see {@link flatMap} when `f` returns an `Option`
      * @see {@link as} to replace the value with a constant
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1404,6 +1451,7 @@ export declare const map: {
      * @see {@link flatMap} when `f` returns an `Option`
      * @see {@link as} to replace the value with a constant
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1429,6 +1477,7 @@ export declare const map: {
  * @see {@link asVoid} to replace with `undefined`
  * @see {@link map} for a general transformation
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1453,6 +1502,7 @@ export declare const as: {
      * @see {@link asVoid} to replace with `undefined`
      * @see {@link map} for a general transformation
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1477,6 +1527,7 @@ export declare const as: {
      * @see {@link asVoid} to replace with `undefined`
      * @see {@link map} for a general transformation
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1502,6 +1553,7 @@ export declare const as: {
  *
  * @see {@link as} to replace with a specific constant
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1525,6 +1577,7 @@ export {
  *
  * @see {@link asVoid} to convert an existing `Option` to `Option<void>`
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1568,6 +1621,7 @@ void_ as void };
  * @see {@link andThen} for a more flexible variant
  * @see {@link flatten} to unwrap a nested `Option<Option<A>>`
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -1611,6 +1665,7 @@ export declare const flatMap: {
      * @see {@link andThen} for a more flexible variant
      * @see {@link flatten} to unwrap a nested `Option<Option<A>>`
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1654,6 +1709,7 @@ export declare const flatMap: {
      * @see {@link andThen} for a more flexible variant
      * @see {@link flatten} to unwrap a nested `Option<Option<A>>`
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1693,6 +1749,7 @@ export declare const flatMap: {
  * @see {@link flatMap} for the standard monadic bind
  * @see {@link map} when you always return a plain value
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -1731,6 +1788,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1769,6 +1827,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1807,6 +1866,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1845,6 +1905,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1883,6 +1944,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1921,6 +1983,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1959,6 +2022,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1997,6 +2061,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2037,6 +2102,7 @@ export declare const andThen: {
  * @see {@link flatMap} when the function already returns `Option`
  * @see {@link fromNullishOr} for single-value conversion
  *
+ * @stability stable
  * @category sequencing
  * @since 4.0.0
  */
@@ -2076,6 +2142,7 @@ export declare const flatMapNullishOr: {
      * @see {@link flatMap} when the function already returns `Option`
      * @see {@link fromNullishOr} for single-value conversion
      *
+     * @stability stable
      * @category sequencing
      * @since 4.0.0
      */
@@ -2115,6 +2182,7 @@ export declare const flatMapNullishOr: {
      * @see {@link flatMap} when the function already returns `Option`
      * @see {@link fromNullishOr} for single-value conversion
      *
+     * @stability stable
      * @category sequencing
      * @since 4.0.0
      */
@@ -2144,6 +2212,7 @@ export declare const flatMapNullishOr: {
  *
  * @see {@link flatMap} which is `map` + `flatten`
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2173,6 +2242,7 @@ export declare const flatten: <A>(self: Option<Option<A>>) => Option<A>;
  * @see {@link zipLeft} to keep the first value instead
  * @see {@link zipWith} to combine both values
  *
+ * @stability stable
  * @category zipping
  * @since 2.0.0
  */
@@ -2202,6 +2272,7 @@ export declare const zipRight: {
      * @see {@link zipLeft} to keep the first value instead
      * @see {@link zipWith} to combine both values
      *
+     * @stability stable
      * @category zipping
      * @since 2.0.0
      */
@@ -2231,6 +2302,7 @@ export declare const zipRight: {
      * @see {@link zipLeft} to keep the first value instead
      * @see {@link zipWith} to combine both values
      *
+     * @stability stable
      * @category zipping
      * @since 2.0.0
      */
@@ -2261,6 +2333,7 @@ export declare const zipRight: {
  * @see {@link zipRight} to keep the second value instead
  * @see {@link zipWith} to combine both values
  *
+ * @stability stable
  * @category zipping
  * @since 2.0.0
  */
@@ -2290,6 +2363,7 @@ export declare const zipLeft: {
      * @see {@link zipRight} to keep the second value instead
      * @see {@link zipWith} to combine both values
      *
+     * @stability stable
      * @category zipping
      * @since 2.0.0
      */
@@ -2319,6 +2393,7 @@ export declare const zipLeft: {
      * @see {@link zipRight} to keep the second value instead
      * @see {@link zipWith} to combine both values
      *
+     * @stability stable
      * @category zipping
      * @since 2.0.0
      */
@@ -2357,6 +2432,7 @@ export declare const zipLeft: {
  *
  * @see {@link flatMap} for single-step chaining
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2394,6 +2470,7 @@ export declare const composeK: {
      *
      * @see {@link flatMap} for single-step chaining
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2431,6 +2508,7 @@ export declare const composeK: {
      *
      * @see {@link flatMap} for single-step chaining
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2466,6 +2544,7 @@ export declare const composeK: {
  * @see {@link flatMap} when you want to transform the value
  * @see {@link filter} for predicate-based filtering
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2500,6 +2579,7 @@ export declare const tap: {
      * @see {@link flatMap} when you want to transform the value
      * @see {@link filter} for predicate-based filtering
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2534,6 +2614,7 @@ export declare const tap: {
      * @see {@link flatMap} when you want to transform the value
      * @see {@link filter} for predicate-based filtering
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -2565,6 +2646,7 @@ export declare const tap: {
  * @see {@link zipWith} to combine with a function instead of a tuple
  * @see {@link all} to combine many `Option`s
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -2595,6 +2677,7 @@ export declare const product: {
      * @see {@link zipWith} to combine with a function instead of a tuple
      * @see {@link all} to combine many `Option`s
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -2625,6 +2708,7 @@ export declare const product: {
      * @see {@link zipWith} to combine with a function instead of a tuple
      * @see {@link all} to combine many `Option`s
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -2659,6 +2743,7 @@ export declare const product: {
  * @see {@link product} for combining exactly two
  * @see {@link all} for tuples, structs, and iterables
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -2692,6 +2777,7 @@ export declare const productMany: {
      * @see {@link product} for combining exactly two
      * @see {@link all} for tuples, structs, and iterables
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -2725,6 +2811,7 @@ export declare const productMany: {
      * @see {@link product} for combining exactly two
      * @see {@link all} for tuples, structs, and iterables
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -2766,6 +2853,7 @@ export declare const productMany: {
  * @see {@link product} for combining exactly two
  * @see {@link productMany} for a homogeneous collection
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -2802,6 +2890,7 @@ export declare const all: <const I extends Iterable<Option<any>> | Record<string
  * @see {@link product} to combine into a tuple instead
  * @see {@link lift2} to lift a binary function
  *
+ * @stability stable
  * @category zipping
  * @since 2.0.0
  */
@@ -2834,6 +2923,7 @@ export declare const zipWith: {
      * @see {@link product} to combine into a tuple instead
      * @see {@link lift2} to lift a binary function
      *
+     * @stability stable
      * @category zipping
      * @since 2.0.0
      */
@@ -2866,6 +2956,7 @@ export declare const zipWith: {
      * @see {@link product} to combine into a tuple instead
      * @see {@link lift2} to lift a binary function
      *
+     * @stability stable
      * @category zipping
      * @since 2.0.0
      */
@@ -2895,6 +2986,7 @@ export declare const zipWith: {
  * pipe(items, Option.reduceCompact(0, (b, a) => b + a)) // => 3
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -2923,6 +3015,7 @@ export declare const reduceCompact: {
      * pipe(items, Option.reduceCompact(0, (b, a) => b + a)) // => 3
      * ```
      *
+     * @stability stable
      * @category folding
      * @since 2.0.0
      */
@@ -2951,6 +3044,7 @@ export declare const reduceCompact: {
      * pipe(items, Option.reduceCompact(0, (b, a) => b + a)) // => 3
      * ```
      *
+     * @stability stable
      * @category folding
      * @since 2.0.0
      */
@@ -2980,6 +3074,7 @@ export declare const reduceCompact: {
  *
  * @see {@link fromIterable} for the inverse direction
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -3015,6 +3110,7 @@ export declare const toArray: <A>(self: Option<A>) => Array<A>;
  *
  * @see {@link filter} for simple predicate-based filtering
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -3050,6 +3146,7 @@ export declare const partitionMap: {
      *
      * @see {@link filter} for simple predicate-based filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3085,6 +3182,7 @@ export declare const partitionMap: {
      *
      * @see {@link filter} for simple predicate-based filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3116,6 +3214,7 @@ export declare const partitionMap: {
  *
  * @see {@link filter} for predicate-based filtering
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -3146,6 +3245,7 @@ export declare const filterMap: {
      *
      * @see {@link filter} for predicate-based filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3176,6 +3276,7 @@ export declare const filterMap: {
      *
      * @see {@link filter} for predicate-based filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3213,6 +3314,7 @@ export declare const filterMap: {
  * @see {@link filterMap} to transform and filter simultaneously
  * @see {@link exists} to test without filtering
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -3249,6 +3351,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3285,6 +3388,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3321,6 +3425,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3357,6 +3462,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -3388,6 +3494,7 @@ export declare const filter: {
  * eq(Option.none(), Option.none()) // => true
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 4.0.0
  */
@@ -3419,6 +3526,7 @@ export declare const makeEquivalence: <A>(isEquivalent: Equivalence.Equivalence<
  * ord(Option.some(1), Option.some(2)) // => -1
  * ```
  *
+ * @stability stable
  * @category sorting
  * @since 4.0.0
  */
@@ -3449,6 +3557,7 @@ export declare const makeOrder: <A>(O: Order<A>) => Order<Option<A>>;
  *
  * @see {@link zipWith} for a non-lifted variant
  *
+ * @stability stable
  * @category lifting
  * @since 2.0.0
  */
@@ -3485,6 +3594,7 @@ export declare const lift2: <A, B, C>(f: (a: A, b: B) => C) => {
  * @see {@link filter} to apply a predicate to an existing `Option`
  * @see {@link toRefinement} for the inverse direction
  *
+ * @stability stable
  * @category lifting
  * @since 2.0.0
  */
@@ -3519,6 +3629,7 @@ export declare const liftPredicate: {
      * @see {@link filter} to apply a predicate to an existing `Option`
      * @see {@link toRefinement} for the inverse direction
      *
+     * @stability stable
      * @category lifting
      * @since 2.0.0
      */
@@ -3552,6 +3663,7 @@ export declare const liftPredicate: {
      * @see {@link filter} to apply a predicate to an existing `Option`
      * @see {@link toRefinement} for the inverse direction
      *
+     * @stability stable
      * @category lifting
      * @since 2.0.0
      */
@@ -3585,6 +3697,7 @@ export declare const liftPredicate: {
      * @see {@link filter} to apply a predicate to an existing `Option`
      * @see {@link toRefinement} for the inverse direction
      *
+     * @stability stable
      * @category lifting
      * @since 2.0.0
      */
@@ -3618,6 +3731,7 @@ export declare const liftPredicate: {
  *
  * @see {@link contains} for a version using default equality
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -3652,6 +3766,7 @@ export declare const containsWith: <A>(isEquivalent: (self: A, that: A) => boole
  * @see {@link containsWith} for custom equality
  * @see {@link exists} to test with a predicate
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -3683,6 +3798,7 @@ export declare const contains: {
      * @see {@link containsWith} for custom equality
      * @see {@link exists} to test with a predicate
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -3714,6 +3830,7 @@ export declare const contains: {
      * @see {@link containsWith} for custom equality
      * @see {@link exists} to test with a predicate
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -3748,6 +3865,7 @@ export declare const contains: {
  * @see {@link filter} to keep or discard based on a predicate
  * @see {@link contains} to test for a specific value
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -3781,6 +3899,7 @@ export declare const exists: {
      * @see {@link filter} to keep or discard based on a predicate
      * @see {@link contains} to test for a specific value
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -3814,6 +3933,7 @@ export declare const exists: {
      * @see {@link filter} to keep or discard based on a predicate
      * @see {@link contains} to test for a specific value
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -3847,6 +3967,7 @@ export declare const exists: {
      * @see {@link filter} to keep or discard based on a predicate
      * @see {@link contains} to test for a specific value
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -3880,6 +4001,7 @@ export declare const exists: {
      * @see {@link filter} to keep or discard based on a predicate
      * @see {@link contains} to test for a specific value
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -3911,6 +4033,7 @@ export declare const exists: {
  * @see {@link bind} to add `Option` values
  * @see {@link let_ let} to add plain values
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -3941,6 +4064,7 @@ export declare const bindTo: {
      * @see {@link bind} to add `Option` values
      * @see {@link let_ let} to add plain values
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -3973,6 +4097,7 @@ export declare const bindTo: {
      * @see {@link bind} to add `Option` values
      * @see {@link let_ let} to add plain values
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -4014,6 +4139,7 @@ export {
  * @see {@link bind} to add `Option` values
  * @see {@link bindTo} to start by naming an existing `Option`
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -4044,6 +4170,7 @@ let_ as let };
  * @see {@link let_ let} to add plain values
  * @see {@link bindTo} to start by naming an existing `Option`
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -4074,6 +4201,7 @@ export declare const bind: {
      * @see {@link let_ let} to add plain values
      * @see {@link bindTo} to start by naming an existing `Option`
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -4106,6 +4234,7 @@ export declare const bind: {
      * @see {@link let_ let} to add plain values
      * @see {@link bindTo} to start by naming an existing `Option`
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -4140,6 +4269,7 @@ export declare const bind: {
  * @see {@link let_ let} to add plain values
  * @see {@link bindTo} to start by naming an existing `Option`
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -4176,6 +4306,7 @@ export declare const Do: Option<{}>;
  *
  * @see {@link Do} / {@link bind} for the do notation alternative
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -4208,6 +4339,7 @@ export declare const gen: Gen.Gen<OptionTypeLambda>;
  *
  * @see {@link makeReducerFailFast} for fail-fast semantics
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -4239,6 +4371,7 @@ export declare function makeReducer<A>(combiner: Combiner.Combiner<A>): Reducer.
  *
  * @see {@link makeReducerFailFast} to get a full `Reducer`
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -4271,6 +4404,7 @@ export declare function makeCombinerFailFast<A>(combiner: Combiner.Combiner<A>):
  * @see {@link makeCombinerFailFast} for just the combiner
  * @see {@link makeReducer} for non-fail-fast semantics
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */