effect 4.0.1 → 4.0.2

package/src/Option.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"
@@ -49,6 +50,7 @@ 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
  */
@@ -69,6 +71,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
  */
@@ -96,6 +99,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
  */
@@ -122,6 +126,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
  */
@@ -152,6 +157,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
  */
@@ -166,6 +172,7 @@ export interface OptionUnify<A extends { [Unify.typeSymbol]?: any }> {
  *
  * Use to access type-level helpers associated with `Option`.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Option {
@@ -205,6 +212,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
  */
@@ -218,6 +226,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
  */
@@ -250,6 +259,7 @@ export interface OptionTypeLambda extends TypeLambda {
  *
  * @see {@link some} for the opposite operation.
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -280,6 +290,7 @@ export const none = <A = never>(): Option<A> => option.none
  *
  * @see {@link none} for the opposite operation.
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -311,6 +322,7 @@ export const some: <A>(value: A) => Option<A> = option.some
  * @see {@link isNone} to check for `None` specifically
  * @see {@link isSome} to check for `Some` specifically
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -338,6 +350,7 @@ export const isOption: (input: unknown) => input is Option<unknown> = option.isO
  *
  * @see {@link isSome} for the opposite check.
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -365,6 +378,7 @@ export const isNone: <A>(self: Option<A>) => self is None<A> = option.isNone
  *
  * @see {@link isNone} for the opposite check.
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -397,6 +411,7 @@ export const isSome: <A>(self: Option<A>) => self is Some<A> = option.isSome
  *
  * @see {@link getOrElse} for unwrapping with a default
  *
+ * @stability stable
  * @category pattern matching
  * @since 2.0.0
  */
@@ -428,6 +443,7 @@ export const match: {
    *
    * @see {@link getOrElse} for unwrapping with a default
    *
+   * @stability stable
    * @category pattern matching
    * @since 2.0.0
    */
@@ -464,6 +480,7 @@ export const match: {
    *
    * @see {@link getOrElse} for unwrapping with a default
    *
+   * @stability stable
    * @category pattern matching
    * @since 2.0.0
    */
@@ -516,6 +533,7 @@ export const match: {
  *
  * @see {@link liftPredicate} for the reverse direction
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -546,6 +564,7 @@ export const toRefinement = <A, B extends A>(f: (a: A) => Option<B>): (a: A) =>
  *
  * @see {@link toArray} for the inverse direction
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -580,6 +599,7 @@ export const fromIterable = <A>(collection: Iterable<A>): Option<A> => {
  *
  * @see {@link getFailure} for the opposite operation.
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -609,6 +629,7 @@ export const getSuccess: <A, E>(self: Result<A, E>) => Option<A> = result.getSuc
  *
  * @see {@link getSuccess} for the opposite operation.
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -641,6 +662,7 @@ export const getFailure: <A, E>(self: Result<A, E>) => Option<E> = result.getFai
  * @see {@link getOrUndefined} to fall back to `undefined`
  * @see {@link getOrThrow} to throw on `None`
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -672,6 +694,7 @@ export 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
    */
@@ -703,6 +726,7 @@ export 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
    */
@@ -738,6 +762,7 @@ export 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
  */
@@ -768,6 +793,7 @@ export 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
    */
@@ -798,6 +824,7 @@ export 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
    */
@@ -831,6 +858,7 @@ export const orElse: {
  *
  * @see {@link orElse} when the fallback is itself an `Option`
  *
+ * @stability stable
  * @category error handling
  * @since 2.0.0
  */
@@ -859,6 +887,7 @@ export const orElseSome: {
    *
    * @see {@link orElse} when the fallback is itself an `Option`
    *
+   * @stability stable
    * @category error handling
    * @since 2.0.0
    */
@@ -887,6 +916,7 @@ export const orElseSome: {
    *
    * @see {@link orElse} when the fallback is itself an `Option`
    *
+   * @stability stable
    * @category error handling
    * @since 2.0.0
    */
@@ -923,6 +953,7 @@ export const orElseSome: {
  *
  * @see {@link orElse} for the simpler variant without source tracking
  *
+ * @stability stable
  * @category error handling
  * @since 4.0.0
  */
@@ -954,6 +985,7 @@ export const orElseResult: {
    *
    * @see {@link orElse} for the simpler variant without source tracking
    *
+   * @stability stable
    * @category error handling
    * @since 4.0.0
    */
@@ -985,6 +1017,7 @@ export const orElseResult: {
    *
    * @see {@link orElse} for the simpler variant without source tracking
    *
+   * @stability stable
    * @category error handling
    * @since 4.0.0
    */
@@ -1022,6 +1055,7 @@ export const orElseResult: {
  *
  * @see {@link orElse} for a two-option fallback
  *
+ * @stability stable
  * @category error handling
  * @since 2.0.0
  */
@@ -1064,6 +1098,7 @@ export const firstSomeOf = <T, C extends Iterable<Option<T>> = Iterable<Option<T
  * @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
  */
@@ -1098,6 +1133,7 @@ export const fromNullishOr = <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
  */
@@ -1132,6 +1168,7 @@ export const fromUndefinedOr = <A>(
  * @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
  */
@@ -1171,6 +1208,7 @@ export const fromNullOr = <A>(
  * @see {@link fromNullishOr} for converting a single value
  * @see {@link liftThrowable} for functions that throw instead
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1203,6 +1241,7 @@ export const liftNullishOr = <A extends ReadonlyArray<unknown>, B>(
  * @see {@link getOrUndefined} to return `undefined` instead
  * @see {@link getOrElse} for a custom fallback
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1233,6 +1272,7 @@ export const getOrNull: <A>(self: Option<A>) => A | null = getOrElse(constNull)
  * @see {@link getOrNull} to return `null` instead
  * @see {@link getOrElse} for a custom fallback
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1263,6 +1303,7 @@ export const getOrUndefined: <A>(self: Option<A>) => A | undefined = getOrElse(c
  *
  * @see {@link liftNullishOr} for nullable-returning functions
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -1307,6 +1348,7 @@ export const liftThrowable = <A extends ReadonlyArray<unknown>, B>(
  * @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
  */
@@ -1341,6 +1383,7 @@ export 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
    */
@@ -1375,6 +1418,7 @@ export 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
    */
@@ -1416,6 +1460,7 @@ export 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
  */
@@ -1447,6 +1492,7 @@ export const getOrThrow: <A>(self: Option<A>) => A = getOrThrowWith(() => new Er
  * @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
  */
@@ -1477,6 +1523,7 @@ export 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
    */
@@ -1507,6 +1554,7 @@ export 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
    */
@@ -1536,6 +1584,7 @@ export const map: {
  * @see {@link asVoid} to replace with `undefined`
  * @see {@link map} for a general transformation
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1560,6 +1609,7 @@ export const as: {
    * @see {@link asVoid} to replace with `undefined`
    * @see {@link map} for a general transformation
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -1584,6 +1634,7 @@ export const as: {
    * @see {@link asVoid} to replace with `undefined`
    * @see {@link map} for a general transformation
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -1610,6 +1661,7 @@ export const as: {
  *
  * @see {@link as} to replace with a specific constant
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1634,6 +1686,7 @@ export {
    *
    * @see {@link asVoid} to convert an existing `Option` to `Option<void>`
    *
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -1679,6 +1732,7 @@ export {
  * @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
  */
@@ -1722,6 +1776,7 @@ export 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
    */
@@ -1765,6 +1820,7 @@ export 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
    */
@@ -1808,6 +1864,7 @@ export 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
  */
@@ -1846,6 +1903,7 @@ export 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
    */
@@ -1884,6 +1942,7 @@ export 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
    */
@@ -1922,6 +1981,7 @@ export 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
    */
@@ -1960,6 +2020,7 @@ export 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
    */
@@ -1998,6 +2059,7 @@ export 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
    */
@@ -2036,6 +2098,7 @@ export 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
    */
@@ -2074,6 +2137,7 @@ export 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
    */
@@ -2112,6 +2176,7 @@ export 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
    */
@@ -2160,6 +2225,7 @@ export 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
  */
@@ -2199,6 +2265,7 @@ export 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
    */
@@ -2238,6 +2305,7 @@ export 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
    */
@@ -2272,6 +2340,7 @@ export const flatMapNullishOr: {
  *
  * @see {@link flatMap} which is `map` + `flatten`
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2302,6 +2371,7 @@ export const flatten: <A>(self: Option<Option<A>>) => Option<A> = flatMap(identi
  * @see {@link zipLeft} to keep the first value instead
  * @see {@link zipWith} to combine both values
  *
+ * @stability stable
  * @category zipping
  * @since 2.0.0
  */
@@ -2331,6 +2401,7 @@ export 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
    */
@@ -2360,6 +2431,7 @@ export 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
    */
@@ -2391,6 +2463,7 @@ export 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
  */
@@ -2420,6 +2493,7 @@ export 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
    */
@@ -2449,6 +2523,7 @@ export 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
    */
@@ -2488,6 +2563,7 @@ export const zipLeft: {
  *
  * @see {@link flatMap} for single-step chaining
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -2525,6 +2601,7 @@ export const composeK: {
    *
    * @see {@link flatMap} for single-step chaining
    *
+   * @stability stable
    * @category sequencing
    * @since 2.0.0
    */
@@ -2562,6 +2639,7 @@ export const composeK: {
    *
    * @see {@link flatMap} for single-step chaining
    *
+   * @stability stable
    * @category sequencing
    * @since 2.0.0
    */
@@ -2598,6 +2676,7 @@ export 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
  */
@@ -2632,6 +2711,7 @@ export 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
    */
@@ -2666,6 +2746,7 @@ export 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
    */
@@ -2698,6 +2779,7 @@ export 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
  */
@@ -2728,6 +2810,7 @@ export 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
    */
@@ -2758,6 +2841,7 @@ export 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
    */
@@ -2797,6 +2881,7 @@ export 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
  */
@@ -2830,6 +2915,7 @@ export 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
    */
@@ -2863,6 +2949,7 @@ export 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
    */
@@ -2917,6 +3004,7 @@ export const productMany: {
  * @see {@link product} for combining exactly two
  * @see {@link productMany} for a homogeneous collection
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -2980,6 +3068,7 @@ export const all: <const I extends Iterable<Option<any>> | Record<string, Option
  * @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
  */
@@ -3012,6 +3101,7 @@ export 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
    */
@@ -3044,6 +3134,7 @@ export 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
    */
@@ -3078,6 +3169,7 @@ export const zipWith: {
  * pipe(items, Option.reduceCompact(0, (b, a) => b + a)) // => 3
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -3106,6 +3198,7 @@ export const reduceCompact: {
    * pipe(items, Option.reduceCompact(0, (b, a) => b + a)) // => 3
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -3134,6 +3227,7 @@ export const reduceCompact: {
    * pipe(items, Option.reduceCompact(0, (b, a) => b + a)) // => 3
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -3175,6 +3269,7 @@ export const reduceCompact: {
  *
  * @see {@link fromIterable} for the inverse direction
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -3211,6 +3306,7 @@ export const toArray = <A>(self: Option<A>): Array<A> => isNone(self) ? [] : [se
  *
  * @see {@link filter} for simple predicate-based filtering
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -3246,6 +3342,7 @@ export const partitionMap: {
    *
    * @see {@link filter} for simple predicate-based filtering
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -3281,6 +3378,7 @@ export const partitionMap: {
    *
    * @see {@link filter} for simple predicate-based filtering
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -3322,6 +3420,7 @@ export const partitionMap: {
  *
  * @see {@link filter} for predicate-based filtering
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -3352,6 +3451,7 @@ export const filterMap: {
    *
    * @see {@link filter} for predicate-based filtering
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -3382,6 +3482,7 @@ export const filterMap: {
    *
    * @see {@link filter} for predicate-based filtering
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -3426,6 +3527,7 @@ export 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
  */
@@ -3462,6 +3564,7 @@ export 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
    */
@@ -3498,6 +3601,7 @@ export 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
    */
@@ -3534,6 +3638,7 @@ export 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
    */
@@ -3570,6 +3675,7 @@ export 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
    */
@@ -3606,6 +3712,7 @@ export const filter: {
  * eq(Option.none(), Option.none()) // => true
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 4.0.0
  */
@@ -3639,6 +3746,7 @@ export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Eq
  * ord(Option.some(1), Option.some(2)) // => -1
  * ```
  *
+ * @stability stable
  * @category sorting
  * @since 4.0.0
  */
@@ -3671,6 +3779,7 @@ export 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
  */
@@ -3708,6 +3817,7 @@ export 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
  */
@@ -3742,6 +3852,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @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
    */
@@ -3775,6 +3886,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @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
    */
@@ -3808,6 +3920,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @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
    */
@@ -3845,6 +3958,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
  *
  * @see {@link contains} for a version using default equality
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -3880,6 +3994,7 @@ export const containsWith = <A>(isEquivalent: (self: A, that: A) => boolean): {
  * @see {@link containsWith} for custom equality
  * @see {@link exists} to test with a predicate
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -3911,6 +4026,7 @@ export const contains: {
    * @see {@link containsWith} for custom equality
    * @see {@link exists} to test with a predicate
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -3942,6 +4058,7 @@ export const contains: {
    * @see {@link containsWith} for custom equality
    * @see {@link exists} to test with a predicate
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -3977,6 +4094,7 @@ export 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
  */
@@ -4010,6 +4128,7 @@ export 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
    */
@@ -4043,6 +4162,7 @@ export 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
    */
@@ -4076,6 +4196,7 @@ export 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
    */
@@ -4109,6 +4230,7 @@ export 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
    */
@@ -4149,6 +4271,7 @@ export 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
  */
@@ -4183,6 +4306,7 @@ export 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
    */
@@ -4217,6 +4341,7 @@ export 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
    */
@@ -4261,6 +4386,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
    */
@@ -4293,6 +4419,7 @@ export {
  * @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
  */
@@ -4323,6 +4450,7 @@ export 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
    */
@@ -4353,6 +4481,7 @@ export 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
    */
@@ -4390,6 +4519,7 @@ export 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
  */
@@ -4427,6 +4557,7 @@ export const Do: Option<{}> = some({})
  *
  * @see {@link Do} / {@link bind} for the do notation alternative
  *
+ * @stability stable
  * @category generators
  * @since 2.0.0
  */
@@ -4472,6 +4603,7 @@ export const gen: Gen.Gen<OptionTypeLambda> = (...args) => {
  *
  * @see {@link makeReducerFailFast} for fail-fast semantics
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -4510,6 +4642,7 @@ export function makeReducer<A>(combiner: Combiner.Combiner<A>): Reducer.Reducer<
  *
  * @see {@link makeReducerFailFast} to get a full `Reducer`
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -4548,6 +4681,7 @@ export function makeCombinerFailFast<A>(combiner: Combiner.Combiner<A>): Combine
  * @see {@link makeCombinerFailFast} for just the combiner
  * @see {@link makeReducer} for non-fail-fast semantics
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */