effect 3.10.18 → 3.11.0

package/src/Option.ts

@@ -125,11 +125,13 @@ export const some: <A>(value: A) => Option<A> = option.some
  * @param input - The value to check.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.isOption(Option.some(1)), true)
  * assert.deepStrictEqual(Option.isOption(Option.none()), true)
  * assert.deepStrictEqual(Option.isOption({}), false)
+ * ```
  *
  * @category guards
  * @since 2.0.0
@@ -142,10 +144,12 @@ export const isOption: (input: unknown) => input is Option<unknown> = option.isO
  * @param self - The `Option` to check.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.isNone(Option.some(1)), false)
  * assert.deepStrictEqual(Option.isNone(Option.none()), true)
+ * ```
  *
  * @category guards
  * @since 2.0.0
@@ -158,10 +162,12 @@ export const isNone: <A>(self: Option<A>) => self is None<A> = option.isNone
  * @param self - The `Option` to check.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.isSome(Option.some(1)), true)
  * assert.deepStrictEqual(Option.isSome(Option.none()), false)
+ * ```
  *
  * @category guards
  * @since 2.0.0
@@ -177,6 +183,7 @@ export const isSome: <A>(self: Option<A>) => self is Some<A> = option.isSome
  * @param onSome - The function to be called if the `Option` is `Some`, it will be passed the `Option`'s value and its result will be returned
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -188,6 +195,7 @@ export const isSome: <A>(self: Option<A>) => self is Some<A> = option.isSome
  *   pipe(Option.none(), Option.match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
  *   'a none'
  * )
+ * ```
  *
  * @category pattern matching
  * @since 2.0.0
@@ -202,6 +210,7 @@ export const match: {
    * @param onSome - The function to be called if the `Option` is `Some`, it will be passed the `Option`'s value and its result will be returned
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -213,6 +222,7 @@ export const match: {
    *   pipe(Option.none(), Option.match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
    *   'a none'
    * )
+   * ```
    *
    * @category pattern matching
    * @since 2.0.0
@@ -232,6 +242,7 @@ export const match: {
    * @param onSome - The function to be called if the `Option` is `Some`, it will be passed the `Option`'s value and its result will be returned
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -243,6 +254,7 @@ export const match: {
    *   pipe(Option.none(), Option.match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
    *   'a none'
    * )
+   * ```
    *
    * @category pattern matching
    * @since 2.0.0
@@ -267,6 +279,7 @@ export const match: {
  * This function ensures that a type guard definition is type-safe.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * const parsePositive = (n: number): Option.Option<number> =>
@@ -276,6 +289,7 @@ export const match: {
  *
  * assert.deepStrictEqual(isPositive(1), true)
  * assert.deepStrictEqual(isPositive(-1), false)
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -289,10 +303,12 @@ export const toRefinement = <A, B extends A>(f: (a: A) => Option<B>): (a: A) =>
  * @param collection - The `Iterable` to be converted to an `Option`.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.fromIterable([1, 2, 3]), Option.some(1))
  * assert.deepStrictEqual(Option.fromIterable([]), Option.none())
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -308,10 +324,12 @@ export const fromIterable = <A>(collection: Iterable<A>): Option<A> => {
  * Converts a `Either` to an `Option` discarding the error.
  *
  * @example
+ * ```ts
  * import { Option, Either } from "effect"
  *
  * assert.deepStrictEqual(Option.getRight(Either.right('ok')), Option.some('ok'))
  * assert.deepStrictEqual(Option.getRight(Either.left('err')), Option.none())
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -322,10 +340,12 @@ export const getRight: <R, L>(self: Either<R, L>) => Option<R> = either.getRight
  * Converts a `Either` to an `Option` discarding the value.
  *
  * @example
+ * ```ts
  * import { Option, Either } from "effect"
  *
  * assert.deepStrictEqual(Option.getLeft(Either.right("ok")), Option.none())
  * assert.deepStrictEqual(Option.getLeft(Either.left("a")), Option.some("a"))
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -339,10 +359,12 @@ export const getLeft: <R, L>(self: Either<R, L>) => Option<L> = either.getLeft
  * @param onNone - Function that returns the default value to return if the `Option` is `None`.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe(Option.some(1), Option.getOrElse(() => 0)), 1)
  * assert.deepStrictEqual(pipe(Option.none(), Option.getOrElse(() => 0)), 0)
+ * ```
  *
  * @category getters
  * @since 2.0.0
@@ -355,10 +377,12 @@ export const getOrElse: {
    * @param onNone - Function that returns the default value to return if the `Option` is `None`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe(Option.some(1), Option.getOrElse(() => 0)), 1)
    * assert.deepStrictEqual(pipe(Option.none(), Option.getOrElse(() => 0)), 0)
+   * ```
    *
    * @category getters
    * @since 2.0.0
@@ -371,10 +395,12 @@ export const getOrElse: {
    * @param onNone - Function that returns the default value to return if the `Option` is `None`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe(Option.some(1), Option.getOrElse(() => 0)), 1)
    * assert.deepStrictEqual(pipe(Option.none(), Option.getOrElse(() => 0)), 0)
+   * ```
    *
    * @category getters
    * @since 2.0.0
@@ -392,6 +418,7 @@ export const getOrElse: {
  * @param that - The `Option` to return if `self` is `None`.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -422,6 +449,7 @@ export const getOrElse: {
  *   ),
  *   Option.some('a')
  * )
+ * ```
  *
  * @category error handling
  * @since 2.0.0
@@ -434,6 +462,7 @@ export const orElse: {
    * @param that - The `Option` to return if `self` is `None`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -464,6 +493,7 @@ export const orElse: {
    *   ),
    *   Option.some('a')
    * )
+   * ```
    *
    * @category error handling
    * @since 2.0.0
@@ -476,6 +506,7 @@ export const orElse: {
    * @param that - The `Option` to return if `self` is `None`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -506,6 +537,7 @@ export const orElse: {
    *   ),
    *   Option.some('a')
    * )
+   * ```
    *
    * @category error handling
    * @since 2.0.0
@@ -523,6 +555,7 @@ export const orElse: {
  * @param onNone - Function that returns the default value to return if the `Option` is `None`.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -539,6 +572,7 @@ export const orElse: {
  *   ),
  *   Option.some('a')
  * )
+ * ```
  *
  * @category error handling
  * @since 2.0.0
@@ -551,6 +585,7 @@ export const orElseSome: {
    * @param onNone - Function that returns the default value to return if the `Option` is `None`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -567,6 +602,7 @@ export const orElseSome: {
    *   ),
    *   Option.some('a')
    * )
+   * ```
    *
    * @category error handling
    * @since 2.0.0
@@ -579,6 +615,7 @@ export const orElseSome: {
    * @param onNone - Function that returns the default value to return if the `Option` is `None`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -595,6 +632,7 @@ export const orElseSome: {
    *   ),
    *   Option.some('a')
    * )
+   * ```
    *
    * @category error handling
    * @since 2.0.0
@@ -656,9 +694,11 @@ export const orElseEither: {
  * @param collection - An iterable collection of `Option` to be searched.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.firstSomeOf([Option.none(), Option.some(1), Option.some(2)]), Option.some(1))
+ * ```
  *
  * @category error handling
  * @since 2.0.0
@@ -682,11 +722,13 @@ export const firstSomeOf = <T, C extends Iterable<Option<T>> = Iterable<Option<T
  * @param nullableValue - The nullable value to be converted to an `Option`.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.fromNullable(undefined), Option.none())
  * assert.deepStrictEqual(Option.fromNullable(null), Option.none())
  * assert.deepStrictEqual(Option.fromNullable(1), Option.some(1))
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -701,6 +743,7 @@ export const fromNullable = <A>(
  * This API is useful for lifting a function that returns `null` or `undefined` into the `Option` context.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * const parse = (s: string): number | undefined => {
@@ -712,6 +755,7 @@ export const fromNullable = <A>(
  *
  * assert.deepStrictEqual(parseOption('1'), Option.some(1))
  * assert.deepStrictEqual(parseOption('not a number'), Option.none())
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -727,10 +771,12 @@ export const liftNullable = <A extends ReadonlyArray<unknown>, B>(
  * @param self - The `Option` to extract the value from.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.getOrNull(Option.some(1)), 1)
  * assert.deepStrictEqual(Option.getOrNull(Option.none()), null)
+ * ```
  *
  * @category getters
  * @since 2.0.0
@@ -743,10 +789,12 @@ export const getOrNull: <A>(self: Option<A>) => A | null = getOrElse(constNull)
  * @param self - The `Option` to extract the value from.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.getOrUndefined(Option.some(1)), 1)
  * assert.deepStrictEqual(Option.getOrUndefined(Option.none()), undefined)
+ * ```
  *
  * @category getters
  * @since 2.0.0
@@ -762,12 +810,14 @@ export const getOrUndefined: <A>(self: Option<A>) => A | undefined = getOrElse(c
  * @param f - the function that can throw exceptions.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * const parse = Option.liftThrowable(JSON.parse)
  *
  * assert.deepStrictEqual(parse("1"), Option.some(1))
  * assert.deepStrictEqual(parse(""), Option.none())
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -792,6 +842,7 @@ export const liftThrowable = <A extends ReadonlyArray<unknown>, B>(
  * @param onNone - A function that will be called if the `Option` is `None`. It returns the error to be thrown.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -799,6 +850,7 @@ export const liftThrowable = <A extends ReadonlyArray<unknown>, B>(
  *   1
  * )
  * assert.throws(() => Option.getOrThrowWith(Option.none(), () => new Error('Unexpected None')))
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -813,6 +865,7 @@ export const getOrThrowWith: {
    * @param onNone - A function that will be called if the `Option` is `None`. It returns the error to be thrown.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -820,6 +873,7 @@ export const getOrThrowWith: {
    *   1
    * )
    * assert.throws(() => Option.getOrThrowWith(Option.none(), () => new Error('Unexpected None')))
+   * ```
    *
    * @category conversions
    * @since 2.0.0
@@ -834,6 +888,7 @@ export const getOrThrowWith: {
    * @param onNone - A function that will be called if the `Option` is `None`. It returns the error to be thrown.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -841,6 +896,7 @@ export const getOrThrowWith: {
    *   1
    * )
    * assert.throws(() => Option.getOrThrowWith(Option.none(), () => new Error('Unexpected None')))
+   * ```
    *
    * @category conversions
    * @since 2.0.0
@@ -862,10 +918,12 @@ export const getOrThrowWith: {
  * @throws `Error("getOrThrow called on a None")`
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.getOrThrow(Option.some(1)), 1)
  * assert.throws(() => Option.getOrThrow(Option.none()))
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -1043,6 +1101,7 @@ export const andThen: {
  * This is `flatMap` + `fromNullable`, useful when working with optional values.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * interface Employee {
@@ -1074,6 +1133,7 @@ export const andThen: {
  *   ),
  *   Option.none()
  * )
+ * ```
  *
  * @category sequencing
  * @since 2.0.0
@@ -1083,6 +1143,7 @@ export const flatMapNullable: {
    * This is `flatMap` + `fromNullable`, useful when working with optional values.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * interface Employee {
@@ -1114,6 +1175,7 @@ export const flatMapNullable: {
    *   ),
    *   Option.none()
    * )
+   * ```
    *
    * @category sequencing
    * @since 2.0.0
@@ -1123,6 +1185,7 @@ export const flatMapNullable: {
    * This is `flatMap` + `fromNullable`, useful when working with optional values.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * interface Employee {
@@ -1154,6 +1217,7 @@ export const flatMapNullable: {
    *   ),
    *   Option.none()
    * )
+   * ```
    *
    * @category sequencing
    * @since 2.0.0
@@ -1253,6 +1317,7 @@ export const zipLeft: {
  * @param self - The `Option` to apply the function to
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * const getInteger = (n: number) => Number.isInteger(n) ? Option.some(n) : Option.none()
@@ -1260,6 +1325,7 @@ export const zipLeft: {
  * assert.deepStrictEqual(Option.tap(Option.none(), getInteger), Option.none())
  * assert.deepStrictEqual(Option.tap(Option.some(1), getInteger), Option.some(1))
  * assert.deepStrictEqual(Option.tap(Option.some(1.14), getInteger), Option.none())
+ * ```
  *
  * @category sequencing
  * @since 2.0.0
@@ -1275,6 +1341,7 @@ export const tap: {
    * @param self - The `Option` to apply the function to
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * const getInteger = (n: number) => Number.isInteger(n) ? Option.some(n) : Option.none()
@@ -1282,6 +1349,7 @@ export const tap: {
    * assert.deepStrictEqual(Option.tap(Option.none(), getInteger), Option.none())
    * assert.deepStrictEqual(Option.tap(Option.some(1), getInteger), Option.some(1))
    * assert.deepStrictEqual(Option.tap(Option.some(1.14), getInteger), Option.none())
+   * ```
    *
    * @category sequencing
    * @since 2.0.0
@@ -1297,6 +1365,7 @@ export const tap: {
    * @param self - The `Option` to apply the function to
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * const getInteger = (n: number) => Number.isInteger(n) ? Option.some(n) : Option.none()
@@ -1304,6 +1373,7 @@ export const tap: {
    * assert.deepStrictEqual(Option.tap(Option.none(), getInteger), Option.none())
    * assert.deepStrictEqual(Option.tap(Option.some(1), getInteger), Option.some(1))
    * assert.deepStrictEqual(Option.tap(Option.some(1.14), getInteger), Option.none())
+   * ```
    *
    * @category sequencing
    * @since 2.0.0
@@ -1349,11 +1419,13 @@ export const productMany = <A>(
  * @param fields - the struct of `Option`s to be sequenced.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.all([Option.some(1), Option.some(2)]), Option.some([1, 2]))
  * assert.deepStrictEqual(Option.all({ a: Option.some(1), b: Option.some("hello") }), Option.some({ a: 1, b: "hello" }))
  * assert.deepStrictEqual(Option.all({ a: Option.some(1), b: Option.none() }), Option.none())
+ * ```
  *
  * @category combining
  * @since 2.0.0
@@ -1398,6 +1470,7 @@ export const all: <const I extends Iterable<Option<any>> | Record<string, Option
  * @param f - The function used to combine the values of the two `Option`s
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * type Complex = [real: number, imaginary: number]
@@ -1410,6 +1483,7 @@ export const all: <const I extends Iterable<Option<any>> | Record<string, Option
  * assert.deepStrictEqual(Option.zipWith(Option.some(1), Option.some(2), complex), Option.some([1, 2]))
  *
  * assert.deepStrictEqual(Option.zipWith(Option.some(1), complex)(Option.some(2)), Option.some([2, 1]))
+ * ```
  *
  * @category zipping
  * @since 2.0.0
@@ -1423,6 +1497,7 @@ export const zipWith: {
    * @param f - The function used to combine the values of the two `Option`s
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * type Complex = [real: number, imaginary: number]
@@ -1435,6 +1510,7 @@ export const zipWith: {
    * assert.deepStrictEqual(Option.zipWith(Option.some(1), Option.some(2), complex), Option.some([1, 2]))
    *
    * assert.deepStrictEqual(Option.zipWith(Option.some(1), complex)(Option.some(2)), Option.some([2, 1]))
+   * ```
    *
    * @category zipping
    * @since 2.0.0
@@ -1448,6 +1524,7 @@ export const zipWith: {
    * @param f - The function used to combine the values of the two `Option`s
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * type Complex = [real: number, imaginary: number]
@@ -1460,6 +1537,7 @@ export const zipWith: {
    * assert.deepStrictEqual(Option.zipWith(Option.some(1), Option.some(2), complex), Option.some([1, 2]))
    *
    * assert.deepStrictEqual(Option.zipWith(Option.some(1), complex)(Option.some(2)), Option.some([2, 1]))
+   * ```
    *
    * @category zipping
    * @since 2.0.0
@@ -1496,10 +1574,12 @@ export const ap: {
  * @param f - The reducing function that takes the current accumulator value and the unwrapped value of an `Option<A>`.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * const iterable = [Option.some(1), Option.none(), Option.some(2), Option.none()]
  * assert.deepStrictEqual(pipe(iterable, Option.reduceCompact(0, (b, a) => b + a)), 3)
+ * ```
  *
  * @category folding
  * @since 2.0.0
@@ -1513,10 +1593,12 @@ export const reduceCompact: {
    * @param f - The reducing function that takes the current accumulator value and the unwrapped value of an `Option<A>`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * const iterable = [Option.some(1), Option.none(), Option.some(2), Option.none()]
    * assert.deepStrictEqual(pipe(iterable, Option.reduceCompact(0, (b, a) => b + a)), 3)
+   * ```
    *
    * @category folding
    * @since 2.0.0
@@ -1530,10 +1612,12 @@ export const reduceCompact: {
    * @param f - The reducing function that takes the current accumulator value and the unwrapped value of an `Option<A>`.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * const iterable = [Option.some(1), Option.none(), Option.some(2), Option.none()]
    * assert.deepStrictEqual(pipe(iterable, Option.reduceCompact(0, (b, a) => b + a)), 3)
+   * ```
    *
    * @category folding
    * @since 2.0.0
@@ -1560,10 +1644,12 @@ export const reduceCompact: {
  * @param self - The `Option` to convert to an array.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * assert.deepStrictEqual(Option.toArray(Option.some(1)), [1])
  * assert.deepStrictEqual(Option.toArray(Option.none()), [])
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -1605,6 +1691,7 @@ export const partitionMap: {
  * @param f - A function to apply to the value of the `Option`.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * const evenNumber = (n: number) => n % 2 === 0 ? Option.some(n) : Option.none()
@@ -1612,6 +1699,7 @@ export const partitionMap: {
  * assert.deepStrictEqual(Option.filterMap(Option.none(), evenNumber), Option.none())
  * assert.deepStrictEqual(Option.filterMap(Option.some(3), evenNumber), Option.none())
  * assert.deepStrictEqual(Option.filterMap(Option.some(2), evenNumber), Option.some(2))
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1626,6 +1714,7 @@ export const filterMap: {
    * @param f - A function to apply to the value of the `Option`.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * const evenNumber = (n: number) => n % 2 === 0 ? Option.some(n) : Option.none()
@@ -1633,6 +1722,7 @@ export const filterMap: {
    * assert.deepStrictEqual(Option.filterMap(Option.none(), evenNumber), Option.none())
    * assert.deepStrictEqual(Option.filterMap(Option.some(3), evenNumber), Option.none())
    * assert.deepStrictEqual(Option.filterMap(Option.some(2), evenNumber), Option.some(2))
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1647,6 +1737,7 @@ export const filterMap: {
    * @param f - A function to apply to the value of the `Option`.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * const evenNumber = (n: number) => n % 2 === 0 ? Option.some(n) : Option.none()
@@ -1654,6 +1745,7 @@ export const filterMap: {
    * assert.deepStrictEqual(Option.filterMap(Option.none(), evenNumber), Option.none())
    * assert.deepStrictEqual(Option.filterMap(Option.some(3), evenNumber), Option.none())
    * assert.deepStrictEqual(Option.filterMap(Option.some(2), evenNumber), Option.some(2))
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1673,6 +1765,7 @@ export const filterMap: {
  * @param fb - The `Option` to filter.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * // predicate
@@ -1688,6 +1781,7 @@ export const filterMap: {
  * assert.deepStrictEqual(Option.filter(Option.none(), isNumber), Option.none())
  * assert.deepStrictEqual(Option.filter(Option.some('hello'), isNumber), Option.none())
  * assert.deepStrictEqual(Option.filter(Option.some(2), isNumber), Option.some(2))
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1702,6 +1796,7 @@ export const filter: {
    * @param fb - The `Option` to filter.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * // predicate
@@ -1717,6 +1812,7 @@ export const filter: {
    * assert.deepStrictEqual(Option.filter(Option.none(), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some('hello'), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some(2), isNumber), Option.some(2))
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1731,6 +1827,7 @@ export const filter: {
    * @param fb - The `Option` to filter.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * // predicate
@@ -1746,6 +1843,7 @@ export const filter: {
    * assert.deepStrictEqual(Option.filter(Option.none(), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some('hello'), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some(2), isNumber), Option.some(2))
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1760,6 +1858,7 @@ export const filter: {
    * @param fb - The `Option` to filter.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * // predicate
@@ -1775,6 +1874,7 @@ export const filter: {
    * assert.deepStrictEqual(Option.filter(Option.none(), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some('hello'), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some(2), isNumber), Option.some(2))
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1789,6 +1889,7 @@ export const filter: {
    * @param fb - The `Option` to filter.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * // predicate
@@ -1804,6 +1905,7 @@ export const filter: {
    * assert.deepStrictEqual(Option.filter(Option.none(), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some('hello'), isNumber), Option.none())
    * assert.deepStrictEqual(Option.filter(Option.some(2), isNumber), Option.some(2))
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1817,6 +1919,7 @@ export const filter: {
 
 /**
  * @example
+ * ```ts
  * import { Option, Number } from "effect"
  *
  * const isEquivalent = Option.getEquivalence(Number.Equivalence)
@@ -1825,6 +1928,7 @@ export const filter: {
  * assert.deepStrictEqual(isEquivalent(Option.some(1), Option.none()), false)
  * assert.deepStrictEqual(isEquivalent(Option.some(1), Option.some(2)), false)
  * assert.deepStrictEqual(isEquivalent(Option.some(1), Option.some(1)), true)
+ * ```
  *
  * @category equivalence
  * @since 2.0.0
@@ -1840,6 +1944,7 @@ export const getEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Equ
  * `None` is considered to be less than any `Some` value.
  *
  * @example
+ * ```ts
  * import { pipe, Option, Number } from "effect"
  *
  * const O = Option.getOrder(Number.Order)
@@ -1848,6 +1953,7 @@ export const getEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Equ
  * assert.deepStrictEqual(O(Option.some(1), Option.none()), 1)
  * assert.deepStrictEqual(O(Option.some(1), Option.some(2)), -1)
  * assert.deepStrictEqual(O(Option.some(1), Option.some(1)), 0)
+ * ```
  *
  * @category sorting
  * @since 2.0.0
@@ -1875,12 +1981,14 @@ export const lift2 = <A, B, C>(f: (a: A, b: B) => C): {
  * @param predicate - A `Predicate` function that takes in a value of type `A` and returns a boolean.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * const getOption = Option.liftPredicate((n: number) => n >= 0)
  *
  * assert.deepStrictEqual(getOption(-1), Option.none())
  * assert.deepStrictEqual(getOption(1), Option.some(1))
+ * ```
  *
  * @category lifting
  * @since 2.0.0
@@ -1894,12 +2002,14 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @param predicate - A `Predicate` function that takes in a value of type `A` and returns a boolean.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * const getOption = Option.liftPredicate((n: number) => n >= 0)
    *
    * assert.deepStrictEqual(getOption(-1), Option.none())
    * assert.deepStrictEqual(getOption(1), Option.some(1))
+   * ```
    *
    * @category lifting
    * @since 2.0.0
@@ -1912,12 +2022,14 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @param predicate - A `Predicate` function that takes in a value of type `A` and returns a boolean.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * const getOption = Option.liftPredicate((n: number) => n >= 0)
    *
    * assert.deepStrictEqual(getOption(-1), Option.none())
    * assert.deepStrictEqual(getOption(1), Option.some(1))
+   * ```
    *
    * @category lifting
    * @since 2.0.0
@@ -1930,12 +2042,14 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @param predicate - A `Predicate` function that takes in a value of type `A` and returns a boolean.
    *
    * @example
+   * ```ts
    * import { Option } from "effect"
    *
    * const getOption = Option.liftPredicate((n: number) => n >= 0)
    *
    * assert.deepStrictEqual(getOption(-1), Option.none())
    * assert.deepStrictEqual(getOption(1), Option.some(1))
+   * ```
    *
    * @category lifting
    * @since 2.0.0
@@ -1954,11 +2068,13 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
  * @param a - The value to compare against the `Option`.
  *
  * @example
+ * ```ts
  * import { pipe, Option, Number } from "effect"
  *
  * assert.deepStrictEqual(pipe(Option.some(2), Option.containsWith(Number.Equivalence)(2)), true)
  * assert.deepStrictEqual(pipe(Option.some(1), Option.containsWith(Number.Equivalence)(2)), false)
  * assert.deepStrictEqual(pipe(Option.none(), Option.containsWith(Number.Equivalence)(2)), false)
+ * ```
  *
  * @category elements
  * @since 2.0.0
@@ -2000,6 +2116,7 @@ export const contains: {
  * @param predicate - The condition to check.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * const isEven = (n: number) => n % 2 === 0
@@ -2007,6 +2124,7 @@ export const contains: {
  * assert.deepStrictEqual(pipe(Option.some(2), Option.exists(isEven)), true)
  * assert.deepStrictEqual(pipe(Option.some(1), Option.exists(isEven)), false)
  * assert.deepStrictEqual(pipe(Option.none(), Option.exists(isEven)), false)
+ * ```
  *
  * @since 2.0.0
  */
@@ -2018,6 +2136,7 @@ export const exists: {
    * @param predicate - The condition to check.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * const isEven = (n: number) => n % 2 === 0
@@ -2025,6 +2144,7 @@ export const exists: {
    * assert.deepStrictEqual(pipe(Option.some(2), Option.exists(isEven)), true)
    * assert.deepStrictEqual(pipe(Option.some(1), Option.exists(isEven)), false)
    * assert.deepStrictEqual(pipe(Option.none(), Option.exists(isEven)), false)
+   * ```
    *
    * @since 2.0.0
    */
@@ -2036,6 +2156,7 @@ export const exists: {
    * @param predicate - The condition to check.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * const isEven = (n: number) => n % 2 === 0
@@ -2043,6 +2164,7 @@ export const exists: {
    * assert.deepStrictEqual(pipe(Option.some(2), Option.exists(isEven)), true)
    * assert.deepStrictEqual(pipe(Option.some(1), Option.exists(isEven)), false)
    * assert.deepStrictEqual(pipe(Option.none(), Option.exists(isEven)), false)
+   * ```
    *
    * @since 2.0.0
    */
@@ -2054,6 +2176,7 @@ export const exists: {
    * @param predicate - The condition to check.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * const isEven = (n: number) => n % 2 === 0
@@ -2061,6 +2184,7 @@ export const exists: {
    * assert.deepStrictEqual(pipe(Option.some(2), Option.exists(isEven)), true)
    * assert.deepStrictEqual(pipe(Option.some(1), Option.exists(isEven)), false)
    * assert.deepStrictEqual(pipe(Option.none(), Option.exists(isEven)), false)
+   * ```
    *
    * @since 2.0.0
    */
@@ -2072,6 +2196,7 @@ export const exists: {
    * @param predicate - The condition to check.
    *
    * @example
+   * ```ts
    * import { pipe, Option } from "effect"
    *
    * const isEven = (n: number) => n % 2 === 0
@@ -2079,6 +2204,7 @@ export const exists: {
    * assert.deepStrictEqual(pipe(Option.some(2), Option.exists(isEven)), true)
    * assert.deepStrictEqual(pipe(Option.some(1), Option.exists(isEven)), false)
    * assert.deepStrictEqual(pipe(Option.none(), Option.exists(isEven)), false)
+   * ```
    *
    * @since 2.0.0
    */
@@ -2109,6 +2235,7 @@ export const exists: {
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Option, pipe } from "effect"
  *
  * const result = pipe(
@@ -2119,6 +2246,7 @@ export const exists: {
  *   Option.filter(({ x, y }) => x * y > 5)
  * )
  * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
+ * ```
  *
  * @category do notation
  * @since 2.0.0
@@ -2144,6 +2272,7 @@ export const bindTo: {
    * @see {@link let_ let}
    *
    * @example
+   * ```ts
    * import { Option, pipe } from "effect"
    *
    * const result = pipe(
@@ -2154,6 +2283,7 @@ export const bindTo: {
    *   Option.filter(({ x, y }) => x * y > 5)
    * )
    * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
+   * ```
    *
    * @category do notation
    * @since 2.0.0
@@ -2179,6 +2309,7 @@ export const bindTo: {
    * @see {@link let_ let}
    *
    * @example
+   * ```ts
    * import { Option, pipe } from "effect"
    *
    * const result = pipe(
@@ -2189,6 +2320,7 @@ export const bindTo: {
    *   Option.filter(({ x, y }) => x * y > 5)
    * )
    * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
+   * ```
    *
    * @category do notation
    * @since 2.0.0
@@ -2225,6 +2357,7 @@ export {
    * @see {@link bindTo}
    *
    * @example
+   * ```ts
    * import { Option, pipe } from "effect"
    *
    * const result = pipe(
@@ -2236,6 +2369,7 @@ export {
    * )
    * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
    *
+   * ```
    * @category do notation
    * @since 2.0.0
    */
@@ -2258,6 +2392,7 @@ export {
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Option, pipe } from "effect"
  *
  * const result = pipe(
@@ -2268,6 +2403,7 @@ export {
  *   Option.filter(({ x, y }) => x * y > 5)
  * )
  * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
+ * ```
  *
  * @category do notation
  * @since 2.0.0
@@ -2289,6 +2425,7 @@ export const bind: {
    * @see {@link let_ let}
    *
    * @example
+   * ```ts
    * import { Option, pipe } from "effect"
    *
    * const result = pipe(
@@ -2299,6 +2436,7 @@ export const bind: {
    *   Option.filter(({ x, y }) => x * y > 5)
    * )
    * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
+   * ```
    *
    * @category do notation
    * @since 2.0.0
@@ -2323,6 +2461,7 @@ export const bind: {
    * @see {@link let_ let}
    *
    * @example
+   * ```ts
    * import { Option, pipe } from "effect"
    *
    * const result = pipe(
@@ -2333,6 +2472,7 @@ export const bind: {
    *   Option.filter(({ x, y }) => x * y > 5)
    * )
    * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
+   * ```
    *
    * @category do notation
    * @since 2.0.0
@@ -2360,6 +2500,7 @@ export const bind: {
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Option, pipe } from "effect"
  *
  * const result = pipe(
@@ -2370,6 +2511,7 @@ export const bind: {
  *   Option.filter(({ x, y }) => x * y > 5)
  * )
  * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
+ * ```
  *
  * @category do notation
  * @since 2.0.0