effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/Option.ts

@@ -121,7 +121,7 @@ export type Option<A> = None<A> | Some<A>
  *
  * - Use as a type guard target when narrowing via {@link isNone}
  *
- * **Behavior**
+ * **Details**
  *
  * - `_tag` is always `"None"`
  * - Implements `Pipeable`, `Inspectable`, and structural equality
@@ -166,7 +166,7 @@ export interface OptionIterator<T extends Option<any>> {
  * - Use as a type guard target when narrowing via {@link isSome}
  * - Access the inner value via `.value`
  *
- * **Behavior**
+ * **Details**
  *
  * - `_tag` is always `"Some"`
  * - `.value` holds the contained value of type `A`
@@ -195,6 +195,8 @@ export interface Some<out A> extends Pipeable, Inspectable {
 /**
  * Type-level unification support for `Option` values.
  *
+ * **Details**
+ *
  * 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.
@@ -236,6 +238,8 @@ export declare namespace Option {
 /**
  * Marker interface used by Effect's `Unify` machinery for `Option` values.
  *
+ * **Details**
+ *
  * This supports type-level unification behavior for `Option`. Users normally
  * do not need to reference this interface directly.
  *
@@ -262,7 +266,7 @@ export interface OptionTypeLambda extends TypeLambda {
  * - Representing a missing or uninitialized value
  * - Returning "no result" from a function
  *
- * **Behavior**
+ * **Details**
  *
  * - Returns `Option<never>`, which is a subtype of `Option<A>` for any `A`
  * - Always returns the same singleton instance
@@ -295,7 +299,7 @@ export const none = <A = never>(): Option<A> => option.none
  * - Wrapping a known-present value as `Option`
  * - Returning a successful result from a partial function
  *
- * **Behavior**
+ * **Details**
  *
  * - Always returns `Some<A>`
  * - Does not filter `null` or `undefined`; use {@link fromNullishOr} for that
@@ -328,7 +332,7 @@ export const some: <A>(value: A) => Option<A> = option.some
  * - Validating unknown values at runtime boundaries
  * - Type-narrowing in union types
  *
- * **Behavior**
+ * **Details**
  *
  * - Returns `true` for both `Some` and `None` instances
  * - Acts as a type guard, narrowing the input to `Option<unknown>`
@@ -363,7 +367,7 @@ export const isOption: (input: unknown) => input is Option<unknown> = option.isO
  *
  * - Branching on absence before accessing `.value`
  *
- * **Behavior**
+ * **Details**
  *
  * - Acts as a type guard, narrowing to `None<A>`
  *
@@ -393,7 +397,7 @@ export const isNone: <A>(self: Option<A>) => self is None<A> = option.isNone
  *
  * - Branching on presence before accessing `.value`
  *
- * **Behavior**
+ * **Details**
  *
  * - Acts as a type guard, narrowing to `Some<A>`
  *
@@ -424,7 +428,7 @@ export const isSome: <A>(self: Option<A>) => self is Some<A> = option.isSome
  * - Exhaustively handling both branches in one expression
  * - Transforming an `Option` into a plain value
  *
- * **Behavior**
+ * **Details**
  *
  * - If `None`, calls `onNone` and returns its result
  * - If `Some`, calls `onSome` with the value and returns its result
@@ -458,7 +462,7 @@ export const match: {
    * - Exhaustively handling both branches in one expression
    * - Transforming an `Option` into a plain value
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `None`, calls `onNone` and returns its result
    * - If `Some`, calls `onSome` with the value and returns its result
@@ -497,7 +501,7 @@ export const match: {
    * - Exhaustively handling both branches in one expression
    * - Transforming an `Option` into a plain value
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `None`, calls `onNone` and returns its result
    * - If `Some`, calls `onSome` with the value and returns its result
@@ -545,7 +549,7 @@ export const match: {
  * - Turning a parsing function into a type-narrowing predicate
  * - Filtering arrays with `Array.prototype.filter`
  *
- * **Behavior**
+ * **Details**
  *
  * - Returns `true` when the original function returns `Some`
  * - Returns `false` when the original function returns `None`
@@ -588,7 +592,7 @@ export const toRefinement = <A, B extends A>(f: (a: A) => Option<B>): (a: A) =>
  * - Safely extracting the head of a collection
  * - Working with generators or lazy iterables
  *
- * **Behavior**
+ * **Details**
  *
  * - Only consumes the first element; does not iterate the rest
  * - Returns `None` for empty iterables
@@ -620,7 +624,7 @@ export 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 failure channel when you only care about success
  *
@@ -651,7 +655,7 @@ export const getSuccess: <A, E>(self: Result<A, E>) => Option<A> = result.getSuc
 /**
  * Converts a `Result` into an `Option`, keeping only the failure value.
  *
- * **When to Use**
+ * **When to use**
  *
  * - Extracting the failure when you do not need the success value
  *
@@ -687,7 +691,7 @@ export const getFailure: <A, E>(self: Result<A, E>) => Option<E> = result.getFai
  * - Providing a default value for an absent `Option`
  * - Unwrapping with lazy evaluation of the fallback
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → returns the inner value
  * - `None` → calls `onNone()` and returns its result
@@ -721,7 +725,7 @@ export const getOrElse: {
    * - Providing a default value for an absent `Option`
    * - Unwrapping with lazy evaluation of the fallback
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns the inner value
    * - `None` → calls `onNone()` and returns its result
@@ -755,7 +759,7 @@ export const getOrElse: {
    * - Providing a default value for an absent `Option`
    * - Unwrapping with lazy evaluation of the fallback
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns the inner value
    * - `None` → calls `onNone()` and returns its result
@@ -794,7 +798,7 @@ export const getOrElse: {
  * - Chaining fallback `Option` computations
  * - Building priority chains of optional values
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → returns `self` unchanged
  * - `None` → evaluates and returns `that()`
@@ -827,7 +831,7 @@ export const orElse: {
    * - Chaining fallback `Option` computations
    * - Building priority chains of optional values
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns `self` unchanged
    * - `None` → evaluates and returns `that()`
@@ -860,7 +864,7 @@ export const orElse: {
    * - Chaining fallback `Option` computations
    * - Building priority chains of optional values
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns `self` unchanged
    * - `None` → evaluates and returns `that()`
@@ -898,7 +902,7 @@ export const orElse: {
  *
  * - Providing a default plain value (not an `Option`) as fallback
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → returns `self` unchanged
  * - `None` → calls `onNone()`, wraps result in `Some`, and returns it
@@ -929,7 +933,7 @@ export const orElseSome: {
    *
    * - Providing a default plain value (not an `Option`) as fallback
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns `self` unchanged
    * - `None` → calls `onNone()`, wraps result in `Some`, and returns it
@@ -960,7 +964,7 @@ export const orElseSome: {
    *
    * - Providing a default plain value (not an `Option`) as fallback
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns `self` unchanged
    * - `None` → calls `onNone()`, wraps result in `Some`, and returns it
@@ -996,7 +1000,7 @@ export const orElseSome: {
  *
  * - Distinguishing whether a value came from the primary or fallback `Option`
  *
- * **Behavior**
+ * **Details**
  *
  * - `self` is `Some` → `Some(Result.fail(value))` (value from primary)
  * - `self` is `None`, `that()` is `Some` → `Some(Result.succeed(value))` (value from fallback)
@@ -1028,7 +1032,7 @@ export const orElseResult: {
    *
    * - Distinguishing whether a value came from the primary or fallback `Option`
    *
-   * **Behavior**
+   * **Details**
    *
    * - `self` is `Some` → `Some(Result.fail(value))` (value from primary)
    * - `self` is `None`, `that()` is `Some` → `Some(Result.succeed(value))` (value from fallback)
@@ -1060,7 +1064,7 @@ export const orElseResult: {
    *
    * - Distinguishing whether a value came from the primary or fallback `Option`
    *
-   * **Behavior**
+   * **Details**
    *
    * - `self` is `Some` → `Some(Result.fail(value))` (value from primary)
    * - `self` is `None`, `that()` is `Some` → `Some(Result.succeed(value))` (value from fallback)
@@ -1098,7 +1102,7 @@ export const orElseResult: {
  *
  * - Searching for the first available value in a priority list
  *
- * **Behavior**
+ * **Details**
  *
  * - Short-circuits on the first `Some`
  * - Returns `None` only when every element is `None`
@@ -1141,7 +1145,7 @@ export const firstSomeOf = <T, C extends Iterable<Option<T>> = Iterable<Option<T
  * - Bridging from nullable APIs to `Option`
  * - Wrapping values that may be `null` or `undefined`
  *
- * **Behavior**
+ * **Details**
  *
  * - `null` or `undefined` → `None`
  * - Any other value → `Some` (typed as `NonNullable<A>`)
@@ -1180,7 +1184,7 @@ export const fromNullishOr = <A>(
  *
  * - When `null` is a meaningful value but `undefined` means absent
  *
- * **Behavior**
+ * **Details**
  *
  * - `undefined` → `None`
  * - Any other value (including `null`) → `Some`
@@ -1218,7 +1222,7 @@ export const fromUndefinedOr = <A>(
  *
  * - When `undefined` is a meaningful value but `null` means absent
  *
- * **Behavior**
+ * **Details**
  *
  * - `null` → `None`
  * - Any other value (including `undefined`) → `Some`
@@ -1256,7 +1260,7 @@ export const fromNullOr = <A>(
  *
  * - Wrapping existing nullable-returning functions for use in `Option` pipelines
  *
- * **Behavior**
+ * **Details**
  *
  * - Calls the original function with the given arguments
  * - Wraps the result via {@link fromNullishOr}
@@ -1298,7 +1302,7 @@ export const liftNullishOr = <A extends ReadonlyArray<unknown>, B>(
  *
  * - Interoping with APIs that use `null` for missing values
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → the inner value
  * - `None` → `null`
@@ -1330,7 +1334,7 @@ export const getOrNull: <A>(self: Option<A>) => A | null = getOrElse(constNull)
  *
  * - Interoping with APIs that use `undefined` for missing values
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → the inner value
  * - `None` → `undefined`
@@ -1362,7 +1366,7 @@ export const getOrUndefined: <A>(self: Option<A>) => A | undefined = getOrElse(c
  *
  * - Wrapping exception-throwing APIs (e.g. `JSON.parse`) for safe usage
  *
- * **Behavior**
+ * **Details**
  *
  * - If the function returns normally → `Some` with the result
  * - If the function throws → `None` (exception is swallowed)
@@ -1405,7 +1409,7 @@ export const liftThrowable = <A extends ReadonlyArray<unknown>, B>(
  * - Fail-fast unwrapping when absence is unexpected
  * - Providing a descriptive error for debugging
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → returns the inner value
  * - `None` → throws the value returned by `onNone()`
@@ -1437,7 +1441,7 @@ export const getOrThrowWith: {
    * - Fail-fast unwrapping when absence is unexpected
    * - Providing a descriptive error for debugging
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns the inner value
    * - `None` → throws the value returned by `onNone()`
@@ -1469,7 +1473,7 @@ export const getOrThrowWith: {
    * - Fail-fast unwrapping when absence is unexpected
    * - Providing a descriptive error for debugging
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → returns the inner value
    * - `None` → throws the value returned by `onNone()`
@@ -1507,7 +1511,7 @@ export const getOrThrowWith: {
  *
  * - Quick fail-fast unwrapping when a generic error is acceptable
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → returns the inner value
  * - `None` → throws `new Error("getOrThrow called on a None")`
@@ -1541,7 +1545,7 @@ export const getOrThrow: <A>(self: Option<A>) => A = getOrThrowWith(() => new Er
  * - Applying a pure transformation to an optional value
  * - Chaining transformations in a pipeline
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → applies `f` and wraps the result in a new `Some`
  * - `None` → returns `None` unchanged
@@ -1575,7 +1579,7 @@ export const map: {
    * - Applying a pure transformation to an optional value
    * - Chaining transformations in a pipeline
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → applies `f` and wraps the result in a new `Some`
    * - `None` → returns `None` unchanged
@@ -1609,7 +1613,7 @@ export const map: {
    * - Applying a pure transformation to an optional value
    * - Chaining transformations in a pipeline
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → applies `f` and wraps the result in a new `Some`
    * - `None` → returns `None` unchanged
@@ -1646,7 +1650,7 @@ export const map: {
  *
  * - Preserving presence/absence while discarding the original value
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → `Some(b)`
  * - `None` → `None`
@@ -1677,7 +1681,7 @@ export const as: {
    *
    * - Preserving presence/absence while discarding the original value
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → `Some(b)`
    * - `None` → `None`
@@ -1708,7 +1712,7 @@ export const as: {
    *
    * - Preserving presence/absence while discarding the original value
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → `Some(b)`
    * - `None` → `None`
@@ -1742,7 +1746,7 @@ export const as: {
  *
  * - Discarding the value while preserving presence/absence
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → `Some(undefined)`
  * - `None` → `None`
@@ -1801,7 +1805,7 @@ export {
  * - Chaining computations that each may fail (return `None`)
  * - Sequencing dependent optional operations
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → applies `f` to the value and returns its `Option` result
  * - `None` → returns `None` without calling `f`
@@ -1847,7 +1851,7 @@ export const flatMap: {
    * - Chaining computations that each may fail (return `None`)
    * - Sequencing dependent optional operations
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → applies `f` to the value and returns its `Option` result
    * - `None` → returns `None` without calling `f`
@@ -1893,7 +1897,7 @@ export const flatMap: {
    * - Chaining computations that each may fail (return `None`)
    * - Sequencing dependent optional operations
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` → applies `f` to the value and returns its `Option` result
    * - `None` → returns `None` without calling `f`
@@ -1944,7 +1948,7 @@ export const flatMap: {
  * - Flexible chaining where the next step may return `Option`, a plain value,
  *   or a function
  *
- * **Behavior**
+ * **Details**
  *
  * - If `self` is `None`, returns `None` immediately
  * - If `f` is a function, calls it with the `Some` value
@@ -1985,7 +1989,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2026,7 +2030,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2067,7 +2071,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2108,7 +2112,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2149,7 +2153,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2190,7 +2194,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2231,7 +2235,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2272,7 +2276,7 @@ export const andThen: {
    * - Flexible chaining where the next step may return `Option`, a plain value,
    *   or a function
    *
-   * **Behavior**
+   * **Details**
    *
    * - If `self` is `None`, returns `None` immediately
    * - If `f` is a function, calls it with the `Some` value
@@ -2322,7 +2326,7 @@ export const andThen: {
  * - Chaining with functions that use `null`/`undefined` instead of `Option`
  * - Navigating deeply nested optional properties
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` → `None`
  * - `Some` → applies `f`, then wraps via {@link fromNullishOr}
@@ -2364,7 +2368,7 @@ export const flatMapNullishOr: {
    * - Chaining with functions that use `null`/`undefined` instead of `Option`
    * - Navigating deeply nested optional properties
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` → applies `f`, then wraps via {@link fromNullishOr}
@@ -2406,7 +2410,7 @@ export const flatMapNullishOr: {
    * - Chaining with functions that use `null`/`undefined` instead of `Option`
    * - Navigating deeply nested optional properties
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` → applies `f`, then wraps via {@link fromNullishOr}
@@ -2452,7 +2456,7 @@ export const flatMapNullishOr: {
  *
  * - Removing one layer of `Option` nesting
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some(Some(value))` → `Some(value)`
  * - `Some(None)` → `None`
@@ -2484,7 +2488,7 @@ export const flatten: <A>(self: Option<Option<A>>) => Option<A> = flatMap(identi
  *
  * - Running a side-condition that must succeed, then using the second value
  *
- * **Behavior**
+ * **Details**
  *
  * - Both `Some` → returns `that`
  * - Either `None` → returns `None`
@@ -2515,7 +2519,7 @@ export const zipRight: {
    *
    * - Running a side-condition that must succeed, then using the second value
    *
-   * **Behavior**
+   * **Details**
    *
    * - Both `Some` → returns `that`
    * - Either `None` → returns `None`
@@ -2546,7 +2550,7 @@ export const zipRight: {
    *
    * - Running a side-condition that must succeed, then using the second value
    *
-   * **Behavior**
+   * **Details**
    *
    * - Both `Some` → returns `that`
    * - Either `None` → returns `None`
@@ -2579,7 +2583,7 @@ export const zipRight: {
  *
  * - Running a validation that must succeed, but keeping the original value
  *
- * **Behavior**
+ * **Details**
  *
  * - Both `Some` → returns `self`
  * - Either `None` → returns `None`
@@ -2610,7 +2614,7 @@ export const zipLeft: {
    *
    * - Running a validation that must succeed, but keeping the original value
    *
-   * **Behavior**
+   * **Details**
    *
    * - Both `Some` → returns `self`
    * - Either `None` → returns `None`
@@ -2641,7 +2645,7 @@ export const zipLeft: {
    *
    * - Running a validation that must succeed, but keeping the original value
    *
-   * **Behavior**
+   * **Details**
    *
    * - Both `Some` → returns `self`
    * - Either `None` → returns `None`
@@ -2675,7 +2679,7 @@ export const zipLeft: {
  *
  * - Building pipelines of partial functions (Kleisli composition)
  *
- * **Behavior**
+ * **Details**
  *
  * - Calls `afb(a)`, then if `Some`, calls `bfc` with its value
  * - Short-circuits to `None` if either function returns `None`
@@ -2714,7 +2718,7 @@ export const composeK: {
    *
    * - Building pipelines of partial functions (Kleisli composition)
    *
-   * **Behavior**
+   * **Details**
    *
    * - Calls `afb(a)`, then if `Some`, calls `bfc` with its value
    * - Short-circuits to `None` if either function returns `None`
@@ -2753,7 +2757,7 @@ export const composeK: {
    *
    * - Building pipelines of partial functions (Kleisli composition)
    *
-   * **Behavior**
+   * **Details**
    *
    * - Calls `afb(a)`, then if `Some`, calls `bfc` with its value
    * - Short-circuits to `None` if either function returns `None`
@@ -2796,7 +2800,7 @@ export const composeK: {
  * - Validating a value without transforming it
  * - Adding a side-condition check in a pipeline
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` → `None`
  * - `Some` → calls `f(value)`; if result is `Some`, returns original `self`; if `None`, returns `None`
@@ -2833,7 +2837,7 @@ export const tap: {
    * - Validating a value without transforming it
    * - Adding a side-condition check in a pipeline
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` → calls `f(value)`; if result is `Some`, returns original `self`; if `None`, returns `None`
@@ -2870,7 +2874,7 @@ export const tap: {
    * - Validating a value without transforming it
    * - Adding a side-condition check in a pipeline
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` → calls `f(value)`; if result is `Some`, returns original `self`; if `None`, returns `None`
@@ -2907,7 +2911,7 @@ export const tap: {
  *
  * - Pairing two optional values together
  *
- * **Behavior**
+ * **Details**
  *
  * - Both `Some` → `Some([a, b])`
  * - Either `None` → `None`
@@ -2941,7 +2945,7 @@ export const product = <A, B>(self: Option<A>, that: Option<B>): Option<[A, B]>
  *
  * - Collecting several `Option`s of the same type into a non-empty tuple
  *
- * **Behavior**
+ * **Details**
  *
  * - All `Some` → `Some([self.value, ...rest])`
  * - Any `None` → `None`
@@ -2993,7 +2997,7 @@ export const productMany = <A>(
  * - Collecting multiple `Option`s into one, preserving the input shape
  * - "All or nothing" combination — any `None` makes the result `None`
  *
- * **Behavior**
+ * **Details**
  *
  * - Tuple input → `Option` of a tuple with the same length
  * - Struct input → `Option` of a struct with the same keys
@@ -3068,7 +3072,7 @@ export const all: <const I extends Iterable<Option<any>> | Record<string, Option
  *
  * - Merging two optional values into a computed result
  *
- * **Behavior**
+ * **Details**
  *
  * - Both `Some` → applies `f(a, b)` and wraps in `Some`
  * - Either `None` → `None`
@@ -3103,7 +3107,7 @@ export const zipWith: {
    *
    * - Merging two optional values into a computed result
    *
-   * **Behavior**
+   * **Details**
    *
    * - Both `Some` → applies `f(a, b)` and wraps in `Some`
    * - Either `None` → `None`
@@ -3138,7 +3142,7 @@ export const zipWith: {
    *
    * - Merging two optional values into a computed result
    *
-   * **Behavior**
+   * **Details**
    *
    * - Both `Some` → applies `f(a, b)` and wraps in `Some`
    * - Either `None` → `None`
@@ -3179,7 +3183,7 @@ export const zipWith: {
  *
  * - Aggregating values from a collection where some may be absent
  *
- * **Behavior**
+ * **Details**
  *
  * - Iterates through the collection, applying `f` only to `Some` values
  * - `None` values are skipped entirely
@@ -3207,7 +3211,7 @@ export const reduceCompact: {
    *
    * - Aggregating values from a collection where some may be absent
    *
-   * **Behavior**
+   * **Details**
    *
    * - Iterates through the collection, applying `f` only to `Some` values
    * - `None` values are skipped entirely
@@ -3235,7 +3239,7 @@ export const reduceCompact: {
    *
    * - Aggregating values from a collection where some may be absent
    *
-   * **Behavior**
+   * **Details**
    *
    * - Iterates through the collection, applying `f` only to `Some` values
    * - `None` values are skipped entirely
@@ -3277,7 +3281,7 @@ export const reduceCompact: {
  * - Interfacing with array-based APIs
  * - Spreading optional values into collections
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` → single-element array `[value]`
  * - `None` → empty array `[]`
@@ -3308,7 +3312,7 @@ export const toArray = <A>(self: Option<A>): Array<A> => isNone(self) ? [] : [se
  *
  * - Categorizing an optional value into "left" (failure) and "right" (success) channels
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` → `[None, None]`
  * - `Some` where `f` returns `Err` → `[Some(error), None]`
@@ -3347,7 +3351,7 @@ export const partitionMap: {
    *
    * - Categorizing an optional value into "left" (failure) and "right" (success) channels
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `[None, None]`
    * - `Some` where `f` returns `Err` → `[Some(error), None]`
@@ -3386,7 +3390,7 @@ export const partitionMap: {
    *
    * - Categorizing an optional value into "left" (failure) and "right" (success) channels
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `[None, None]`
    * - `Some` where `f` returns `Err` → `[Some(error), None]`
@@ -3432,6 +3436,8 @@ export const partitionMap: {
 /**
  * Transforms and filters an `Option` using a `Filter` callback.
  *
+ * **Details**
+ *
  * The callback returns a `Result`: `Result.succeed` keeps and transforms the
  * value, while `Result.fail` discards it.
  *
@@ -3456,6 +3462,8 @@ export const filterMap: {
   /**
    * Transforms and filters an `Option` using a `Filter` callback.
    *
+   * **Details**
+   *
    * The callback returns a `Result`: `Result.succeed` keeps and transforms the
    * value, while `Result.fail` discards it.
    *
@@ -3480,6 +3488,8 @@ export const filterMap: {
   /**
    * Transforms and filters an `Option` using a `Filter` callback.
    *
+   * **Details**
+   *
    * The callback returns a `Result`: `Result.succeed` keeps and transforms the
    * value, while `Result.fail` discards it.
    *
@@ -3518,7 +3528,7 @@ export const filterMap: {
  * - Discarding values that don't meet a condition
  * - Narrowing the type via a refinement predicate
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` → `None`
  * - `Some` where `predicate(value)` is `true` → `Some(value)`
@@ -3559,7 +3569,7 @@ export const filter: {
    * - Discarding values that don't meet a condition
    * - Narrowing the type via a refinement predicate
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` where `predicate(value)` is `true` → `Some(value)`
@@ -3600,7 +3610,7 @@ export const filter: {
    * - Discarding values that don't meet a condition
    * - Narrowing the type via a refinement predicate
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` where `predicate(value)` is `true` → `Some(value)`
@@ -3641,7 +3651,7 @@ export const filter: {
    * - Discarding values that don't meet a condition
    * - Narrowing the type via a refinement predicate
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` where `predicate(value)` is `true` → `Some(value)`
@@ -3682,7 +3692,7 @@ export const filter: {
    * - Discarding values that don't meet a condition
    * - Narrowing the type via a refinement predicate
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `None`
    * - `Some` where `predicate(value)` is `true` → `Some(value)`
@@ -3727,7 +3737,7 @@ export const filter: {
  *
  * - Comparing two `Option` values for structural equality
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` vs `None` → `true`
  * - `Some` vs `None` (or vice versa) → `false`
@@ -3763,7 +3773,7 @@ export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Eq
  *
  * - Sorting collections of `Option` values
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` is considered less than any `Some`
  * - Two `Some` values are compared using the provided `Order`
@@ -3799,7 +3809,7 @@ export const makeOrder = <A>(O: Order<A>): Order<Option<A>> =>
  *
  * - Reusing an existing binary function in an `Option` context
  *
- * **Behavior**
+ * **Details**
  *
  * - Both `Some` → applies `f` and wraps in `Some`
  * - Either `None` → `None`
@@ -3837,7 +3847,7 @@ export const lift2 = <A, B, C>(f: (a: A, b: B) => C): {
  * - Converting a boolean check into an `Option`-returning function
  * - Validating input and wrapping it in `Option`
  *
- * **Behavior**
+ * **Details**
  *
  * - `predicate(value)` is `true` → `Some(value)`
  * - `predicate(value)` is `false` → `None`
@@ -3874,7 +3884,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * - Converting a boolean check into an `Option`-returning function
    * - Validating input and wrapping it in `Option`
    *
-   * **Behavior**
+   * **Details**
    *
    * - `predicate(value)` is `true` → `Some(value)`
    * - `predicate(value)` is `false` → `None`
@@ -3910,7 +3920,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * - Converting a boolean check into an `Option`-returning function
    * - Validating input and wrapping it in `Option`
    *
-   * **Behavior**
+   * **Details**
    *
    * - `predicate(value)` is `true` → `Some(value)`
    * - `predicate(value)` is `false` → `None`
@@ -3946,7 +3956,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * - Converting a boolean check into an `Option`-returning function
    * - Validating input and wrapping it in `Option`
    *
-   * **Behavior**
+   * **Details**
    *
    * - `predicate(value)` is `true` → `Some(value)`
    * - `predicate(value)` is `false` → `None`
@@ -3986,7 +3996,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
  *
  * - Testing membership with a custom equality check
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` where `isEquivalent(value, a)` is `true` → `true`
  * - `Some` where not equivalent, or `None` → `false`
@@ -4026,7 +4036,7 @@ export const containsWith = <A>(isEquivalent: (self: A, that: A) => boolean): {
  *
  * - Quick membership test with standard equality
  *
- * **Behavior**
+ * **Details**
  *
  * - `Some` where `Equal.equals(value, a)` is `true` → `true`
  * - `Some` where not equal, or `None` → `false`
@@ -4061,7 +4071,7 @@ export const contains: {
    *
    * - Quick membership test with standard equality
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` where `Equal.equals(value, a)` is `true` → `true`
    * - `Some` where not equal, or `None` → `false`
@@ -4096,7 +4106,7 @@ export const contains: {
    *
    * - Quick membership test with standard equality
    *
-   * **Behavior**
+   * **Details**
    *
    * - `Some` where `Equal.equals(value, a)` is `true` → `true`
    * - `Some` where not equal, or `None` → `false`
@@ -4132,7 +4142,7 @@ export const contains: {
  *
  * - Checking a condition on an optional value without unwrapping
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` → `false`
  * - `Some` where `predicate(value)` is `true` → `true`
@@ -4170,7 +4180,7 @@ export const exists: {
    *
    * - Checking a condition on an optional value without unwrapping
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `false`
    * - `Some` where `predicate(value)` is `true` → `true`
@@ -4208,7 +4218,7 @@ export const exists: {
    *
    * - Checking a condition on an optional value without unwrapping
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `false`
    * - `Some` where `predicate(value)` is `true` → `true`
@@ -4246,7 +4256,7 @@ export const exists: {
    *
    * - Checking a condition on an optional value without unwrapping
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `false`
    * - `Some` where `predicate(value)` is `true` → `true`
@@ -4284,7 +4294,7 @@ export const exists: {
    *
    * - Checking a condition on an optional value without unwrapping
    *
-   * **Behavior**
+   * **Details**
    *
    * - `None` → `false`
    * - `Some` where `predicate(value)` is `true` → `true`
@@ -4617,7 +4627,7 @@ export const Do: Option<{}> = some({})
  * - Writing imperative-style code that chains multiple `Option`s
  * - Readability when many sequential optional steps are involved
  *
- * **Behavior**
+ * **Details**
  *
  * - Each `yield*` unwraps a `Some` value or short-circuits to `None`
  * - The return value is wrapped in `Some`
@@ -4670,7 +4680,7 @@ export const gen: Gen.Gen<OptionTypeLambda> = (...args) => {
  * - Building a reducer that falls back to the first available value
  * - Combining optional values where either side may be absent
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` + `None` → `None`
  * - `Some(a)` + `None` → `Some(a)`
@@ -4709,7 +4719,7 @@ export function makeReducer<A>(combiner: Combiner.Combiner<A>): Reducer.Reducer<
  *
  * - Operations that require both values to be present
  *
- * **Behavior**
+ * **Details**
  *
  * - `None` + anything → `None`
  * - anything + `None` → `None`
@@ -4749,7 +4759,7 @@ export function makeCombinerFailFast<A>(combiner: Combiner.Combiner<A>): Combine
  * - Wrapping an existing `Reducer` to work with `Option` values
  * - Reductions where any `None` should abort the entire result
  *
- * **Behavior**
+ * **Details**
  *
  * - Initial value is `Some(reducer.initialValue)`
  * - Combines only when both operands are `Some`