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

package/dist/Option.d.ts

@@ -70,7 +70,6 @@
  * - {@link gen} for generator-based syntax
  *
  * @since 2.0.0
- * @module
  */
 import * as Combiner from "./Combiner.ts";
 import * as Equivalence from "./Equivalence.ts";
@@ -97,28 +96,11 @@ declare const TypeId = "~effect/data/Option";
  * - Returning from partial functions (not defined for all inputs)
  * - Managing optional fields in data structures
  *
- * **Example** (Creating and matching Options)
- *
- * ```ts
- * import { Option } from "effect"
- *
- * const someValue: Option.Option<number> = Option.some(42)
- * const noneValue: Option.Option<number> = Option.none()
- *
- * const result = Option.match(someValue, {
- *   onNone: () => "No value",
- *   onSome: (value) => `Value is ${value}`
- * })
- *
- * console.log(result)
- * // Output: "Value is 42"
- * ```
- *
  * @see {@link some} for creating a `Some`
  * @see {@link none} for creating a `None`
  * @see {@link match} for pattern matching
  *
- * @category Models
+ * @category models
  * @since 2.0.0
  */
 export type Option<A> = None<A> | Some<A>;
@@ -137,7 +119,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`
  *
- * @category Models
+ * @category models
  * @since 2.0.0
  */
 export interface None<out A> extends Pipeable, Inspectable {
@@ -153,8 +135,11 @@ export interface None<out A> extends Pipeable, Inspectable {
     [Unify.ignoreSymbol]?: OptionUnifyIgnore;
 }
 /**
+ * Iterator protocol used to yield an `Option` inside {@link gen}, returning the
+ * contained value type back to the generator.
+ *
+ * @category Generators
  * @since 4.0.0
- * @category Models
  */
 export interface OptionIterator<T extends Option<any>> {
     next(...args: ReadonlyArray<any>): IteratorResult<T, Option.Value<T>>;
@@ -176,7 +161,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`
  *
- * @category Models
+ * @category models
  * @since 2.0.0
  */
 export interface Some<out A> extends Pipeable, Inspectable {
@@ -193,10 +178,13 @@ export interface Some<out A> extends Pipeable, Inspectable {
     [Unify.ignoreSymbol]?: OptionUnifyIgnore;
 }
 /**
- * Internal unification interface for `Option` types. Used by the Effect
- * library's type system for type-level operations.
+ * Type-level unification support for `Option` values.
  *
- * @category Models
+ * This is used by Effect's `Unify` machinery to preserve the contained value
+ * type when generic code returns or combines `Option` values. Users normally
+ * do not need to reference this interface directly.
+ *
+ * @category models
  * @since 2.0.0
  */
 export interface OptionUnify<A extends {
@@ -207,19 +195,6 @@ export interface OptionUnify<A extends {
 /**
  * Namespace containing utility types for `Option`.
  *
- * **Example** (Extracting the value type)
- *
- * ```ts
- * import type { Option } from "effect"
- *
- * declare const myOption: Option.Option<string>
- *
- * //      ┌─── string
- * //      ▼
- * type MyType = Option.Option.Value<typeof myOption>
- * ```
- *
- * @category Namespaces
  * @since 2.0.0
  */
 export declare namespace Option {
@@ -238,15 +213,18 @@ export declare namespace Option {
      * type MyType = Option.Option.Value<typeof myOption>
      * ```
      *
-     * @since 2.0.0
      * @category Type-level Utils
+     * @since 2.0.0
      */
     type Value<T extends Option<any>> = [T] extends [Option<infer _A>] ? _A : never;
 }
 /**
- * Internal interface for type unification ignore behavior.
+ * Marker interface used by Effect's `Unify` machinery for `Option` values.
  *
- * @category Models
+ * This supports type-level unification behavior for `Option`. Users normally
+ * do not need to reference this interface directly.
+ *
+ * @category models
  * @since 2.0.0
  */
 export interface OptionUnifyIgnore {
@@ -288,7 +266,7 @@ export interface OptionTypeLambda extends TypeLambda {
  *
  * @see {@link some} for the opposite operation.
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export declare const none: <A = never>() => Option<A>;
@@ -320,7 +298,7 @@ export declare const none: <A = never>() => Option<A>;
  *
  * @see {@link none} for the opposite operation.
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export declare const some: <A>(value: A) => Option<A>;
@@ -355,7 +333,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
  *
- * @category Guards
+ * @category guards
  * @since 2.0.0
  */
 export declare const isOption: (input: unknown) => input is Option<unknown>;
@@ -384,7 +362,7 @@ export declare const isOption: (input: unknown) => input is Option<unknown>;
  *
  * @see {@link isSome} for the opposite check.
  *
- * @category Guards
+ * @category guards
  * @since 2.0.0
  */
 export declare const isNone: <A>(self: Option<A>) => self is None<A>;
@@ -413,7 +391,7 @@ export declare const isNone: <A>(self: Option<A>) => self is None<A>;
  *
  * @see {@link isNone} for the opposite check.
  *
- * @category Guards
+ * @category guards
  * @since 2.0.0
  */
 export declare const isSome: <A>(self: Option<A>) => self is Some<A>;
@@ -563,7 +541,7 @@ export declare const match: {
  *
  * @see {@link liftPredicate} for the reverse direction
  *
- * @category Conversions
+ * @category converting
  * @since 2.0.0
  */
 export declare const toRefinement: <A, B extends A>(f: (a: A) => Option<B>) => (a: A) => a is B;
@@ -595,21 +573,21 @@ export declare const toRefinement: <A, B extends A>(f: (a: A) => Option<B>) => (
  *
  * @see {@link toArray} for the inverse direction
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export declare const fromIterable: <A>(collection: Iterable<A>) => Option<A>;
 /**
  * Converts a `Result` into an `Option`, keeping only the success value.
  *
- * **When to use**
+ * **When to Use**
  *
- * - Discarding the error channel when you only care about success
+ * - Discarding the failure channel when you only care about success
  *
- * **Behavior**
+ * **Details**
  *
- * - `Ok` → `Some` with the success value
- * - `Err` → `None` (error is discarded)
+ * - `Success` becomes `Some` with the success value
+ * - `Failure` becomes `None` and the failure value is discarded
  *
  * **Example** (Extracting the success side)
  *
@@ -625,21 +603,21 @@ export declare const fromIterable: <A>(collection: Iterable<A>) => Option<A>;
  *
  * @see {@link getFailure} for the opposite operation.
  *
- * @category Conversions
- * @since 2.0.0
+ * @category converting
+ * @since 4.0.0
  */
 export declare const getSuccess: <A, E>(self: Result<A, E>) => Option<A>;
 /**
- * Converts a `Result` into an `Option`, keeping only the error value.
+ * Converts a `Result` into an `Option`, keeping only the failure value.
  *
- * **When to use**
+ * **When to Use**
  *
- * - Extracting the error when you don't need the success channel
+ * - Extracting the failure when you do not need the success value
  *
- * **Behavior**
+ * **Details**
  *
- * - `Err` → `Some` with the error value
- * - `Ok` → `None` (success value is discarded)
+ * - `Failure` becomes `Some` with the failure value
+ * - `Success` becomes `None` and the success value is discarded
  *
  * **Example** (Extracting the failure side)
  *
@@ -655,8 +633,8 @@ export declare const getSuccess: <A, E>(self: Result<A, E>) => Option<A>;
  *
  * @see {@link getSuccess} for the opposite operation.
  *
- * @category Conversions
- * @since 2.0.0
+ * @category converting
+ * @since 4.0.0
  */
 export declare const getFailure: <A, E>(self: Result<A, E>) => Option<E>;
 /**
@@ -689,7 +667,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`
  *
- * @category Getters
+ * @category getters
  * @since 2.0.0
  */
 export declare const getOrElse: {
@@ -723,7 +701,7 @@ export declare const getOrElse: {
      * @see {@link getOrUndefined} to fall back to `undefined`
      * @see {@link getOrThrow} to throw on `None`
      *
-     * @category Getters
+     * @category getters
      * @since 2.0.0
      */
     <B>(onNone: LazyArg<B>): <A>(self: Option<A>) => B | A;
@@ -757,7 +735,7 @@ export declare const getOrElse: {
      * @see {@link getOrUndefined} to fall back to `undefined`
      * @see {@link getOrThrow} to throw on `None`
      *
-     * @category Getters
+     * @category getters
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, onNone: LazyArg<B>): A | B;
@@ -791,7 +769,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
  *
- * @category Error handling
+ * @category error handling
  * @since 2.0.0
  */
 export declare const orElse: {
@@ -824,7 +802,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
      *
-     * @category Error handling
+     * @category error handling
      * @since 2.0.0
      */
     <B>(that: LazyArg<Option<B>>): <A>(self: Option<A>) => Option<B | A>;
@@ -857,7 +835,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
      *
-     * @category Error handling
+     * @category error handling
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, that: LazyArg<Option<B>>): Option<A | B>;
@@ -889,7 +867,7 @@ export declare const orElse: {
  *
  * @see {@link orElse} when the fallback is itself an `Option`
  *
- * @category Error handling
+ * @category error handling
  * @since 2.0.0
  */
 export declare const orElseSome: {
@@ -920,7 +898,7 @@ export declare const orElseSome: {
      *
      * @see {@link orElse} when the fallback is itself an `Option`
      *
-     * @category Error handling
+     * @category error handling
      * @since 2.0.0
      */
     <B>(onNone: LazyArg<B>): <A>(self: Option<A>) => Option<B | A>;
@@ -951,7 +929,7 @@ export declare const orElseSome: {
      *
      * @see {@link orElse} when the fallback is itself an `Option`
      *
-     * @category Error handling
+     * @category error handling
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>;
@@ -984,8 +962,8 @@ export declare const orElseSome: {
  *
  * @see {@link orElse} for the simpler variant without source tracking
  *
- * @category Error handling
- * @since 2.0.0
+ * @category error handling
+ * @since 4.0.0
  */
 export declare const orElseResult: {
     /**
@@ -1016,8 +994,8 @@ export declare const orElseResult: {
      *
      * @see {@link orElse} for the simpler variant without source tracking
      *
-     * @category Error handling
-     * @since 2.0.0
+     * @category error handling
+     * @since 4.0.0
      */
     <B>(that: LazyArg<Option<B>>): <A>(self: Option<A>) => Option<Result<B, A>>;
     /**
@@ -1048,8 +1026,8 @@ export declare const orElseResult: {
      *
      * @see {@link orElse} for the simpler variant without source tracking
      *
-     * @category Error handling
-     * @since 2.0.0
+     * @category error handling
+     * @since 4.0.0
      */
     <A, B>(self: Option<A>, that: LazyArg<Option<B>>): Option<Result<B, A>>;
 };
@@ -1081,7 +1059,7 @@ export declare const orElseResult: {
  *
  * @see {@link orElse} for a two-option fallback
  *
- * @category Error handling
+ * @category error handling
  * @since 2.0.0
  */
 export declare const firstSomeOf: <T, C extends Iterable<Option<T>> = Iterable<Option<T>>>(collection: C) => [C] extends [Iterable<Option<infer A>>] ? Option<A> : never;
@@ -1117,8 +1095,8 @@ 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
  *
- * @category Conversions
- * @since 2.0.0
+ * @category converting
+ * @since 4.0.0
  */
 export declare const fromNullishOr: <A>(a: A) => Option<NonNullable<A>>;
 /**
@@ -1152,7 +1130,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
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export declare const fromUndefinedOr: <A>(a: A) => Option<Exclude<A, undefined>>;
@@ -1187,7 +1165,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
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export declare const fromNullOr: <A>(a: A) => Option<Exclude<A, null>>;
@@ -1226,8 +1204,8 @@ 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
  *
- * @category Conversions
- * @since 2.0.0
+ * @category converting
+ * @since 4.0.0
  */
 export declare const liftNullishOr: <A extends ReadonlyArray<unknown>, B>(f: (...a: A) => B) => (...a: A) => Option<NonNullable<B>>;
 /**
@@ -1257,7 +1235,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
  *
- * @category Getters
+ * @category getters
  * @since 2.0.0
  */
 export declare const getOrNull: <A>(self: Option<A>) => A | null;
@@ -1288,7 +1266,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
  *
- * @category Getters
+ * @category getters
  * @since 2.0.0
  */
 export declare const getOrUndefined: <A>(self: Option<A>) => A | undefined;
@@ -1320,7 +1298,7 @@ export declare const getOrUndefined: <A>(self: Option<A>) => A | undefined;
  *
  * @see {@link liftNullishOr} for nullable-returning functions
  *
- * @category Conversions
+ * @category converting
  * @since 2.0.0
  */
 export declare const liftThrowable: <A extends ReadonlyArray<unknown>, B>(f: (...a: A) => B) => (...a: A) => Option<B>;
@@ -1352,7 +1330,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
  *
- * @category Conversions
+ * @category converting
  * @since 2.0.0
  */
 export declare const getOrThrowWith: {
@@ -1384,7 +1362,7 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} for a version with a default error
      * @see {@link getOrElse} for a non-throwing alternative
      *
-     * @category Conversions
+     * @category converting
      * @since 2.0.0
      */
     (onNone: () => unknown): <A>(self: Option<A>) => A;
@@ -1416,7 +1394,7 @@ export declare const getOrThrowWith: {
      * @see {@link getOrThrow} for a version with a default error
      * @see {@link getOrElse} for a non-throwing alternative
      *
-     * @category Conversions
+     * @category converting
      * @since 2.0.0
      */
     <A>(self: Option<A>, onNone: () => unknown): A;
@@ -1448,7 +1426,7 @@ export declare const getOrThrowWith: {
  * @see {@link getOrThrowWith} for a custom error
  * @see {@link getOrElse} for a non-throwing alternative
  *
- * @category Conversions
+ * @category converting
  * @since 2.0.0
  */
 export declare const getOrThrow: <A>(self: Option<A>) => A;
@@ -1482,7 +1460,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
  *
- * @category Mapping
+ * @category mapping
  * @since 2.0.0
  */
 export declare const map: {
@@ -1516,7 +1494,7 @@ export declare const map: {
      * @see {@link flatMap} when `f` returns an `Option`
      * @see {@link as} to replace the value with a constant
      *
-     * @category Mapping
+     * @category mapping
      * @since 2.0.0
      */
     <A, B>(f: (a: A) => B): (self: Option<A>) => Option<B>;
@@ -1550,7 +1528,7 @@ export declare const map: {
      * @see {@link flatMap} when `f` returns an `Option`
      * @see {@link as} to replace the value with a constant
      *
-     * @category Mapping
+     * @category mapping
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, f: (a: A) => B): Option<B>;
@@ -1582,7 +1560,7 @@ export declare const map: {
  * @see {@link asVoid} to replace with `undefined`
  * @see {@link map} for a general transformation
  *
- * @category Mapping
+ * @category mapping
  * @since 2.0.0
  */
 export declare const as: {
@@ -1613,7 +1591,7 @@ export declare const as: {
      * @see {@link asVoid} to replace with `undefined`
      * @see {@link map} for a general transformation
      *
-     * @category Mapping
+     * @category mapping
      * @since 2.0.0
      */
     <B>(b: B): <X>(self: Option<X>) => Option<B>;
@@ -1644,7 +1622,7 @@ export declare const as: {
      * @see {@link asVoid} to replace with `undefined`
      * @see {@link map} for a general transformation
      *
-     * @category Mapping
+     * @category mapping
      * @since 2.0.0
      */
     <X, B>(self: Option<X>, b: B): Option<B>;
@@ -1676,7 +1654,7 @@ export declare const as: {
  *
  * @see {@link as} to replace with a specific constant
  *
- * @category Mapping
+ * @category mapping
  * @since 2.0.0
  */
 export declare const asVoid: <_>(self: Option<_>) => Option<void>;
@@ -1700,7 +1678,7 @@ export {
  *
  * @see {@link asVoid} to convert an existing `Option` to `Option<void>`
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 void_ as void };
@@ -1746,7 +1724,7 @@ void_ as void };
  * @see {@link andThen} for a more flexible variant
  * @see {@link flatten} to unwrap a nested `Option<Option<A>>`
  *
- * @category Sequencing
+ * @category sequencing
  * @since 2.0.0
  */
 export declare const flatMap: {
@@ -1792,7 +1770,7 @@ export declare const flatMap: {
      * @see {@link andThen} for a more flexible variant
      * @see {@link flatten} to unwrap a nested `Option<Option<A>>`
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(f: (a: A) => Option<B>): (self: Option<A>) => Option<B>;
@@ -1838,7 +1816,7 @@ export declare const flatMap: {
      * @see {@link andThen} for a more flexible variant
      * @see {@link flatten} to unwrap a nested `Option<Option<A>>`
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, f: (a: A) => Option<B>): Option<B>;
@@ -1880,7 +1858,7 @@ export declare const flatMap: {
  * @see {@link flatMap} for the standard monadic bind
  * @see {@link map} when you always return a plain value
  *
- * @category Sequencing
+ * @category sequencing
  * @since 2.0.0
  */
 export declare const andThen: {
@@ -1921,7 +1899,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(f: (a: A) => Option<B>): (self: Option<A>) => Option<B>;
@@ -1962,7 +1940,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <B>(f: Option<B>): <A>(self: Option<A>) => Option<B>;
@@ -2003,7 +1981,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(f: (a: A) => B): (self: Option<A>) => Option<B>;
@@ -2044,7 +2022,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <B>(f: NotFunction<B>): <A>(self: Option<A>) => Option<B>;
@@ -2085,7 +2063,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, f: (a: A) => Option<B>): Option<B>;
@@ -2126,7 +2104,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, f: Option<B>): Option<B>;
@@ -2167,7 +2145,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, f: (a: A) => B): Option<B>;
@@ -2208,7 +2186,7 @@ export declare const andThen: {
      * @see {@link flatMap} for the standard monadic bind
      * @see {@link map} when you always return a plain value
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B>(self: Option<A>, f: NotFunction<B>): Option<B>;
@@ -2251,8 +2229,8 @@ export declare const andThen: {
  * @see {@link flatMap} when the function already returns `Option`
  * @see {@link fromNullishOr} for single-value conversion
  *
- * @category Sequencing
- * @since 2.0.0
+ * @category sequencing
+ * @since 4.0.0
  */
 export declare const flatMapNullishOr: {
     /**
@@ -2293,8 +2271,8 @@ export declare const flatMapNullishOr: {
      * @see {@link flatMap} when the function already returns `Option`
      * @see {@link fromNullishOr} for single-value conversion
      *
-     * @category Sequencing
-     * @since 2.0.0
+     * @category sequencing
+     * @since 4.0.0
      */
     <A, B>(f: (a: A) => B): (self: Option<A>) => Option<NonNullable<B>>;
     /**
@@ -2335,8 +2313,8 @@ export declare const flatMapNullishOr: {
      * @see {@link flatMap} when the function already returns `Option`
      * @see {@link fromNullishOr} for single-value conversion
      *
-     * @category Sequencing
-     * @since 2.0.0
+     * @category sequencing
+     * @since 4.0.0
      */
     <A, B>(self: Option<A>, f: (a: A) => B): Option<NonNullable<B>>;
 };
@@ -2367,7 +2345,7 @@ export declare const flatMapNullishOr: {
  *
  * @see {@link flatMap} which is `map` + `flatten`
  *
- * @category Sequencing
+ * @category sequencing
  * @since 2.0.0
  */
 export declare const flatten: <A>(self: Option<Option<A>>) => Option<A>;
@@ -2398,7 +2376,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
  *
- * @category Zipping
+ * @category zipping
  * @since 2.0.0
  */
 export declare const zipRight: {
@@ -2429,7 +2407,7 @@ export declare const zipRight: {
      * @see {@link zipLeft} to keep the first value instead
      * @see {@link zipWith} to combine both values
      *
-     * @category Zipping
+     * @category zipping
      * @since 2.0.0
      */
     <B>(that: Option<B>): <_>(self: Option<_>) => Option<B>;
@@ -2460,7 +2438,7 @@ export declare const zipRight: {
      * @see {@link zipLeft} to keep the first value instead
      * @see {@link zipWith} to combine both values
      *
-     * @category Zipping
+     * @category zipping
      * @since 2.0.0
      */
     <X, B>(self: Option<X>, that: Option<B>): Option<B>;
@@ -2492,7 +2470,7 @@ export declare const zipRight: {
  * @see {@link zipRight} to keep the second value instead
  * @see {@link zipWith} to combine both values
  *
- * @category Zipping
+ * @category zipping
  * @since 2.0.0
  */
 export declare const zipLeft: {
@@ -2523,7 +2501,7 @@ export declare const zipLeft: {
      * @see {@link zipRight} to keep the second value instead
      * @see {@link zipWith} to combine both values
      *
-     * @category Zipping
+     * @category zipping
      * @since 2.0.0
      */
     <_>(that: Option<_>): <A>(self: Option<A>) => Option<A>;
@@ -2554,7 +2532,7 @@ export declare const zipLeft: {
      * @see {@link zipRight} to keep the second value instead
      * @see {@link zipWith} to combine both values
      *
-     * @category Zipping
+     * @category zipping
      * @since 2.0.0
      */
     <A, X>(self: Option<A>, that: Option<X>): Option<A>;
@@ -2594,7 +2572,7 @@ export declare const zipLeft: {
  *
  * @see {@link flatMap} for single-step chaining
  *
- * @category Sequencing
+ * @category sequencing
  * @since 2.0.0
  */
 export declare const composeK: {
@@ -2633,7 +2611,7 @@ export declare const composeK: {
      *
      * @see {@link flatMap} for single-step chaining
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <B, C>(bfc: (b: B) => Option<C>): <A>(afb: (a: A) => Option<B>) => (a: A) => Option<C>;
@@ -2672,7 +2650,7 @@ export declare const composeK: {
      *
      * @see {@link flatMap} for single-step chaining
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, B, C>(afb: (a: A) => Option<B>, bfc: (b: B) => Option<C>): (a: A) => Option<C>;
@@ -2710,7 +2688,7 @@ export declare const composeK: {
  * @see {@link flatMap} when you want to transform the value
  * @see {@link filter} for predicate-based filtering
  *
- * @category Sequencing
+ * @category sequencing
  * @since 2.0.0
  */
 export declare const tap: {
@@ -2747,7 +2725,7 @@ export declare const tap: {
      * @see {@link flatMap} when you want to transform the value
      * @see {@link filter} for predicate-based filtering
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, X>(f: (a: A) => Option<X>): (self: Option<A>) => Option<A>;
@@ -2784,7 +2762,7 @@ export declare const tap: {
      * @see {@link flatMap} when you want to transform the value
      * @see {@link filter} for predicate-based filtering
      *
-     * @category Sequencing
+     * @category sequencing
      * @since 2.0.0
      */
     <A, X>(self: Option<A>, f: (a: A) => Option<X>): Option<A>;
@@ -2937,7 +2915,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
  *
- * @category Zipping
+ * @category zipping
  * @since 2.0.0
  */
 export declare const zipWith: {
@@ -2972,7 +2950,7 @@ export declare const zipWith: {
      * @see {@link product} to combine into a tuple instead
      * @see {@link lift2} to lift a binary function
      *
-     * @category Zipping
+     * @category zipping
      * @since 2.0.0
      */
     <B, A, C>(that: Option<B>, f: (a: A, b: B) => C): (self: Option<A>) => Option<C>;
@@ -3007,7 +2985,7 @@ export declare const zipWith: {
      * @see {@link product} to combine into a tuple instead
      * @see {@link lift2} to lift a binary function
      *
-     * @category Zipping
+     * @category zipping
      * @since 2.0.0
      */
     <A, B, C>(self: Option<A>, that: Option<B>, f: (a: A, b: B) => C): Option<C>;
@@ -3124,7 +3102,7 @@ export declare const reduceCompact: {
  *
  * @see {@link fromIterable} for the inverse direction
  *
- * @category Conversions
+ * @category converting
  * @since 2.0.0
  */
 export declare const toArray: <A>(self: Option<A>) => Array<A>;
@@ -3163,7 +3141,7 @@ export declare const toArray: <A>(self: Option<A>) => Array<A>;
  *
  * @see {@link filter} for simple predicate-based filtering
  *
- * @category Filtering
+ * @category filtering
  * @since 2.0.0
  */
 export declare const partitionMap: {
@@ -3202,7 +3180,7 @@ export declare const partitionMap: {
      *
      * @see {@link filter} for simple predicate-based filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A, B, C>(f: (a: A) => Result<C, B>): (self: Option<A>) => [left: Option<B>, right: Option<C>];
@@ -3241,7 +3219,7 @@ export declare const partitionMap: {
      *
      * @see {@link filter} for simple predicate-based filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A, B, C>(self: Option<A>, f: (a: A) => Result<C, B>): [left: Option<B>, right: Option<C>];
@@ -3255,8 +3233,7 @@ export declare const partitionMap: {
  * **Example** (Filtering and transforming)
  *
  * ```ts
- * import { Option } from "effect"
- * import * as Result from "effect/Result"
+ * import { Option, Result } from "effect"
  *
  * console.log(Option.filterMap(
  *   Option.some(2),
@@ -3267,7 +3244,7 @@ export declare const partitionMap: {
  *
  * @see {@link filter} for predicate-based filtering
  *
- * @category Filtering
+ * @category filtering
  * @since 2.0.0
  */
 export declare const filterMap: {
@@ -3280,8 +3257,7 @@ export declare const filterMap: {
      * **Example** (Filtering and transforming)
      *
      * ```ts
-     * import { Option } from "effect"
-     * import * as Result from "effect/Result"
+     * import { Option, Result } from "effect"
      *
      * console.log(Option.filterMap(
      *   Option.some(2),
@@ -3292,7 +3268,7 @@ export declare const filterMap: {
      *
      * @see {@link filter} for predicate-based filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A, B, X>(f: Filter.Filter<A, B, X>): (self: Option<A>) => Option<B>;
@@ -3305,8 +3281,7 @@ export declare const filterMap: {
      * **Example** (Filtering and transforming)
      *
      * ```ts
-     * import { Option } from "effect"
-     * import * as Result from "effect/Result"
+     * import { Option, Result } from "effect"
      *
      * console.log(Option.filterMap(
      *   Option.some(2),
@@ -3317,7 +3292,7 @@ export declare const filterMap: {
      *
      * @see {@link filter} for predicate-based filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A, B, X>(self: Option<A>, f: Filter.Filter<A, B, X>): Option<B>;
@@ -3359,7 +3334,7 @@ export declare const filterMap: {
  * @see {@link filterMap} to transform and filter simultaneously
  * @see {@link exists} to test without filtering
  *
- * @category Filtering
+ * @category filtering
  * @since 2.0.0
  */
 export declare const filter: {
@@ -3400,7 +3375,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A, B extends A>(refinement: Refinement<A, B>): (self: Option<A>) => Option<B>;
@@ -3441,7 +3416,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A>(predicate: Predicate<A>): <B extends A>(self: Option<B>) => Option<B>;
@@ -3482,7 +3457,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A, B extends A>(self: Option<A>, refinement: Refinement<A, B>): Option<B>;
@@ -3523,7 +3498,7 @@ export declare const filter: {
      * @see {@link filterMap} to transform and filter simultaneously
      * @see {@link exists} to test without filtering
      *
-     * @category Filtering
+     * @category filtering
      * @since 2.0.0
      */
     <A>(self: Option<A>, predicate: Predicate<A>): Option<A>;
@@ -3559,7 +3534,7 @@ export declare const filter: {
  * ```
  *
  * @category Equivalence
- * @since 2.0.0
+ * @since 4.0.0
  */
 export declare const makeEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A>) => Equivalence.Equivalence<Option<A>>;
 /**
@@ -3578,8 +3553,7 @@ export declare const makeEquivalence: <A>(isEquivalent: Equivalence.Equivalence<
  * **Example** (Ordering Options)
  *
  * ```ts
- * import { Option } from "effect"
- * import * as N from "effect/Number"
+ * import { Number as N, Option } from "effect"
  *
  * const ord = Option.makeOrder(N.Order)
  *
@@ -3594,7 +3568,7 @@ export declare const makeEquivalence: <A>(isEquivalent: Equivalence.Equivalence<
  * ```
  *
  * @category Sorting
- * @since 2.0.0
+ * @since 4.0.0
  */
 export declare const makeOrder: <A>(O: Order<A>) => Order<Option<A>>;
 /**
@@ -4453,6 +4427,7 @@ export declare const gen: Gen.Gen<OptionTypeLambda>;
  *
  * @see {@link makeReducerFailFast} for fail-fast semantics
  *
+ * @category Reducer
  * @since 4.0.0
  */
 export declare function makeReducer<A>(combiner: Combiner.Combiner<A>): Reducer.Reducer<Option<A>>;
@@ -4485,6 +4460,7 @@ export declare function makeReducer<A>(combiner: Combiner.Combiner<A>): Reducer.
  *
  * @see {@link makeReducerFailFast} to get a full `Reducer`
  *
+ * @category Combiner
  * @since 4.0.0
  */
 export declare function makeCombinerFailFast<A>(combiner: Combiner.Combiner<A>): Combiner.Combiner<Option<A>>;
@@ -4519,6 +4495,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
  *
+ * @category Reducer
  * @since 4.0.0
  */
 export declare function makeReducerFailFast<A>(reducer: Reducer.Reducer<A>): Reducer.Reducer<Option<A>>;