effect 3.10.18 → 3.11.0

package/dist/dts/Option.d.ts

@@ -110,11 +110,13 @@ export declare const some: <A>(value: A) => Option<A>;
  * @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
@@ -126,10 +128,12 @@ export declare const isOption: (input: unknown) => input is Option<unknown>;
  * @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
@@ -141,10 +145,12 @@ export declare const isNone: <A>(self: Option<A>) => self is None<A>;
  * @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
@@ -159,6 +165,7 @@ export declare const isSome: <A>(self: Option<A>) => self is Some<A>;
  * @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(
@@ -170,6 +177,7 @@ export declare const isSome: <A>(self: Option<A>) => self is Some<A>;
  *   pipe(Option.none(), Option.match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
  *   'a none'
  * )
+ * ```
  *
  * @category pattern matching
  * @since 2.0.0
@@ -184,6 +192,7 @@ export declare 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(
@@ -195,6 +204,7 @@ export declare 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
@@ -212,6 +222,7 @@ export declare 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(
@@ -223,6 +234,7 @@ export declare 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
@@ -237,6 +249,7 @@ export declare 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> =>
@@ -246,6 +259,7 @@ export declare const match: {
  *
  * assert.deepStrictEqual(isPositive(1), true)
  * assert.deepStrictEqual(isPositive(-1), false)
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -258,10 +272,12 @@ export declare const toRefinement: <A, B extends A>(f: (a: A) => Option<B>) => (
  * @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
@@ -271,10 +287,12 @@ export declare 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
@@ -284,10 +302,12 @@ export declare const getRight: <R, L>(self: Either<R, L>) => Option<R>;
  * 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
@@ -300,10 +320,12 @@ export declare const getLeft: <R, L>(self: Either<R, L>) => Option<L>;
  * @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
@@ -316,10 +338,12 @@ export declare 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
@@ -332,10 +356,12 @@ export declare 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
@@ -349,6 +375,7 @@ export declare const getOrElse: {
  * @param that - The `Option` to return if `self` is `None`.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -379,6 +406,7 @@ export declare const getOrElse: {
  *   ),
  *   Option.some('a')
  * )
+ * ```
  *
  * @category error handling
  * @since 2.0.0
@@ -391,6 +419,7 @@ export declare const orElse: {
      * @param that - The `Option` to return if `self` is `None`.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * assert.deepStrictEqual(
@@ -421,6 +450,7 @@ export declare const orElse: {
      *   ),
      *   Option.some('a')
      * )
+     * ```
      *
      * @category error handling
      * @since 2.0.0
@@ -433,6 +463,7 @@ export declare const orElse: {
      * @param that - The `Option` to return if `self` is `None`.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * assert.deepStrictEqual(
@@ -463,6 +494,7 @@ export declare const orElse: {
      *   ),
      *   Option.some('a')
      * )
+     * ```
      *
      * @category error handling
      * @since 2.0.0
@@ -476,6 +508,7 @@ export declare 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(
@@ -492,6 +525,7 @@ export declare const orElse: {
  *   ),
  *   Option.some('a')
  * )
+ * ```
  *
  * @category error handling
  * @since 2.0.0
@@ -504,6 +538,7 @@ export declare 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(
@@ -520,6 +555,7 @@ export declare const orElseSome: {
      *   ),
      *   Option.some('a')
      * )
+     * ```
      *
      * @category error handling
      * @since 2.0.0
@@ -532,6 +568,7 @@ export declare 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(
@@ -548,6 +585,7 @@ export declare const orElseSome: {
      *   ),
      *   Option.some('a')
      * )
+     * ```
      *
      * @category error handling
      * @since 2.0.0
@@ -600,9 +638,11 @@ export declare 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
@@ -615,11 +655,13 @@ export declare const firstSomeOf: <T, C extends Iterable<Option<T>> = Iterable<O
  * @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
@@ -629,6 +671,7 @@ export declare const fromNullable: <A>(nullableValue: A) => Option<NonNullable<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 => {
@@ -640,6 +683,7 @@ export declare const fromNullable: <A>(nullableValue: A) => Option<NonNullable<A
  *
  * assert.deepStrictEqual(parseOption('1'), Option.some(1))
  * assert.deepStrictEqual(parseOption('not a number'), Option.none())
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -651,10 +695,12 @@ export declare const liftNullable: <A extends ReadonlyArray<unknown>, B>(f: (...
  * @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
@@ -666,10 +712,12 @@ export declare const getOrNull: <A>(self: Option<A>) => A | null;
  * @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
@@ -684,12 +732,14 @@ export declare const getOrUndefined: <A>(self: Option<A>) => A | undefined;
  * @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
@@ -704,6 +754,7 @@ export declare const liftThrowable: <A extends ReadonlyArray<unknown>, B>(f: (..
  * @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(
@@ -711,6 +762,7 @@ export declare const liftThrowable: <A extends ReadonlyArray<unknown>, B>(f: (..
  *   1
  * )
  * assert.throws(() => Option.getOrThrowWith(Option.none(), () => new Error('Unexpected None')))
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -725,6 +777,7 @@ export declare 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(
@@ -732,6 +785,7 @@ export declare const getOrThrowWith: {
      *   1
      * )
      * assert.throws(() => Option.getOrThrowWith(Option.none(), () => new Error('Unexpected None')))
+     * ```
      *
      * @category conversions
      * @since 2.0.0
@@ -746,6 +800,7 @@ export declare 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(
@@ -753,6 +808,7 @@ export declare const getOrThrowWith: {
      *   1
      * )
      * assert.throws(() => Option.getOrThrowWith(Option.none(), () => new Error('Unexpected None')))
+     * ```
      *
      * @category conversions
      * @since 2.0.0
@@ -768,10 +824,12 @@ export declare 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
@@ -928,6 +986,7 @@ export declare const andThen: {
  * This is `flatMap` + `fromNullable`, useful when working with optional values.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * interface Employee {
@@ -959,6 +1018,7 @@ export declare const andThen: {
  *   ),
  *   Option.none()
  * )
+ * ```
  *
  * @category sequencing
  * @since 2.0.0
@@ -968,6 +1028,7 @@ export declare const flatMapNullable: {
      * This is `flatMap` + `fromNullable`, useful when working with optional values.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * interface Employee {
@@ -999,6 +1060,7 @@ export declare const flatMapNullable: {
      *   ),
      *   Option.none()
      * )
+     * ```
      *
      * @category sequencing
      * @since 2.0.0
@@ -1008,6 +1070,7 @@ export declare const flatMapNullable: {
      * This is `flatMap` + `fromNullable`, useful when working with optional values.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * interface Employee {
@@ -1039,6 +1102,7 @@ export declare const flatMapNullable: {
      *   ),
      *   Option.none()
      * )
+     * ```
      *
      * @category sequencing
      * @since 2.0.0
@@ -1129,6 +1193,7 @@ export declare 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()
@@ -1136,6 +1201,7 @@ export declare 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
@@ -1151,6 +1217,7 @@ export declare 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()
@@ -1158,6 +1225,7 @@ export declare 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
@@ -1173,6 +1241,7 @@ export declare 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()
@@ -1180,6 +1249,7 @@ export declare 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
@@ -1206,11 +1276,13 @@ export declare const productMany: <A>(self: Option<A>, collection: Iterable<Opti
  * @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
@@ -1228,6 +1300,7 @@ export declare const all: <const I extends Iterable<Option<any>> | Record<string
  * @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]
@@ -1240,6 +1313,7 @@ export declare const all: <const I extends Iterable<Option<any>> | Record<string
  * 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
@@ -1253,6 +1327,7 @@ export declare 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]
@@ -1265,6 +1340,7 @@ export declare 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
@@ -1278,6 +1354,7 @@ export declare 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]
@@ -1290,6 +1367,7 @@ export declare 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
@@ -1320,10 +1398,12 @@ export declare 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
@@ -1337,10 +1417,12 @@ export declare 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
@@ -1354,10 +1436,12 @@ export declare 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
@@ -1372,10 +1456,12 @@ export declare 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
@@ -1406,6 +1492,7 @@ export declare 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()
@@ -1413,6 +1500,7 @@ export declare 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
@@ -1427,6 +1515,7 @@ export declare 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()
@@ -1434,6 +1523,7 @@ export declare 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
@@ -1448,6 +1538,7 @@ export declare 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()
@@ -1455,6 +1546,7 @@ export declare 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
@@ -1470,6 +1562,7 @@ export declare const filterMap: {
  * @param fb - The `Option` to filter.
  *
  * @example
+ * ```ts
  * import { Option } from "effect"
  *
  * // predicate
@@ -1485,6 +1578,7 @@ export declare 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
@@ -1499,6 +1593,7 @@ export declare const filter: {
      * @param fb - The `Option` to filter.
      *
      * @example
+     * ```ts
      * import { Option } from "effect"
      *
      * // predicate
@@ -1514,6 +1609,7 @@ export declare 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
@@ -1528,6 +1624,7 @@ export declare const filter: {
      * @param fb - The `Option` to filter.
      *
      * @example
+     * ```ts
      * import { Option } from "effect"
      *
      * // predicate
@@ -1543,6 +1640,7 @@ export declare 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
@@ -1557,6 +1655,7 @@ export declare const filter: {
      * @param fb - The `Option` to filter.
      *
      * @example
+     * ```ts
      * import { Option } from "effect"
      *
      * // predicate
@@ -1572,6 +1671,7 @@ export declare 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
@@ -1586,6 +1686,7 @@ export declare const filter: {
      * @param fb - The `Option` to filter.
      *
      * @example
+     * ```ts
      * import { Option } from "effect"
      *
      * // predicate
@@ -1601,6 +1702,7 @@ export declare 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
@@ -1609,6 +1711,7 @@ export declare const filter: {
 };
 /**
  * @example
+ * ```ts
  * import { Option, Number } from "effect"
  *
  * const isEquivalent = Option.getEquivalence(Number.Equivalence)
@@ -1617,6 +1720,7 @@ export declare 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
@@ -1630,6 +1734,7 @@ export declare const getEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A
  * `None` is considered to be less than any `Some` value.
  *
  * @example
+ * ```ts
  * import { pipe, Option, Number } from "effect"
  *
  * const O = Option.getOrder(Number.Order)
@@ -1638,6 +1743,7 @@ export declare const getEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A
  * 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
@@ -1662,12 +1768,14 @@ export declare 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
@@ -1681,12 +1789,14 @@ export declare const liftPredicate: {
      * @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
@@ -1699,12 +1809,14 @@ export declare const liftPredicate: {
      * @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
@@ -1717,12 +1829,14 @@ export declare const liftPredicate: {
      * @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
@@ -1737,11 +1851,13 @@ export declare const liftPredicate: {
  * @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
@@ -1779,6 +1895,7 @@ export declare const contains: {
  * @param predicate - The condition to check.
  *
  * @example
+ * ```ts
  * import { pipe, Option } from "effect"
  *
  * const isEven = (n: number) => n % 2 === 0
@@ -1786,6 +1903,7 @@ export declare 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
  */
@@ -1797,6 +1915,7 @@ export declare const exists: {
      * @param predicate - The condition to check.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * const isEven = (n: number) => n % 2 === 0
@@ -1804,6 +1923,7 @@ export declare 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
      */
@@ -1815,6 +1935,7 @@ export declare const exists: {
      * @param predicate - The condition to check.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * const isEven = (n: number) => n % 2 === 0
@@ -1822,6 +1943,7 @@ export declare 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
      */
@@ -1833,6 +1955,7 @@ export declare const exists: {
      * @param predicate - The condition to check.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * const isEven = (n: number) => n % 2 === 0
@@ -1840,6 +1963,7 @@ export declare 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
      */
@@ -1851,6 +1975,7 @@ export declare const exists: {
      * @param predicate - The condition to check.
      *
      * @example
+     * ```ts
      * import { pipe, Option } from "effect"
      *
      * const isEven = (n: number) => n % 2 === 0
@@ -1858,6 +1983,7 @@ export declare 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
      */
@@ -1879,6 +2005,7 @@ export declare const exists: {
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Option, pipe } from "effect"
  *
  * const result = pipe(
@@ -1889,6 +2016,7 @@ export declare 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
@@ -1910,6 +2038,7 @@ export declare const bindTo: {
      * @see {@link let_ let}
      *
      * @example
+     * ```ts
      * import { Option, pipe } from "effect"
      *
      * const result = pipe(
@@ -1920,6 +2049,7 @@ export declare 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
@@ -1943,6 +2073,7 @@ export declare const bindTo: {
      * @see {@link let_ let}
      *
      * @example
+     * ```ts
      * import { Option, pipe } from "effect"
      *
      * const result = pipe(
@@ -1953,6 +2084,7 @@ export declare 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
@@ -1986,6 +2118,7 @@ export {
  * @see {@link bindTo}
  *
  * @example
+ * ```ts
  * import { Option, pipe } from "effect"
  *
  * const result = pipe(
@@ -1997,6 +2130,7 @@ export {
  * )
  * assert.deepStrictEqual(result, Option.some({ x: 2, y: 3, sum: 5 }))
  *
+ * ```
  * @category do notation
  * @since 2.0.0
  */
@@ -2017,6 +2151,7 @@ let_ as let };
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Option, pipe } from "effect"
  *
  * const result = pipe(
@@ -2027,6 +2162,7 @@ let_ as let };
  *   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
@@ -2048,6 +2184,7 @@ export declare const bind: {
      * @see {@link let_ let}
      *
      * @example
+     * ```ts
      * import { Option, pipe } from "effect"
      *
      * const result = pipe(
@@ -2058,6 +2195,7 @@ export declare 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
@@ -2081,6 +2219,7 @@ export declare const bind: {
      * @see {@link let_ let}
      *
      * @example
+     * ```ts
      * import { Option, pipe } from "effect"
      *
      * const result = pipe(
@@ -2091,6 +2230,7 @@ export declare 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
@@ -2115,6 +2255,7 @@ export declare const bind: {
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Option, pipe } from "effect"
  *
  * const result = pipe(
@@ -2125,6 +2266,7 @@ export declare 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