effect 3.1.0 → 3.1.2

package/dist/dts/Option.d.ts

@@ -110,11 +110,11 @@ export declare const some: <A>(value: A) => Option<A>;
  * @param input - The value to check.
  *
  * @example
- * import { some, none, isOption } from 'effect/Option'
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(isOption(some(1)), true)
- * assert.deepStrictEqual(isOption(none()), true)
- * assert.deepStrictEqual(isOption({}), false)
+ * 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 +126,10 @@ export declare const isOption: (input: unknown) => input is Option<unknown>;
  * @param self - The `Option` to check.
  *
  * @example
- * import { some, none, isNone } from 'effect/Option'
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(isNone(some(1)), false)
- * assert.deepStrictEqual(isNone(none()), true)
+ * assert.deepStrictEqual(Option.isNone(Option.some(1)), false)
+ * assert.deepStrictEqual(Option.isNone(Option.none()), true)
  *
  * @category guards
  * @since 2.0.0
@@ -141,10 +141,10 @@ export declare const isNone: <A>(self: Option<A>) => self is None<A>;
  * @param self - The `Option` to check.
  *
  * @example
- * import { some, none, isSome } from 'effect/Option'
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(isSome(some(1)), true)
- * assert.deepStrictEqual(isSome(none()), false)
+ * assert.deepStrictEqual(Option.isSome(Option.some(1)), true)
+ * assert.deepStrictEqual(Option.isSome(Option.none()), false)
  *
  * @category guards
  * @since 2.0.0
@@ -159,16 +159,15 @@ 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
- * import { some, none, match } from 'effect/Option'
- * import { pipe } from "effect/Function"
+ * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(
- *   pipe(some(1), match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
+ *   pipe(Option.some(1), Option.match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
  *   'a some containing 1'
  * )
  *
  * assert.deepStrictEqual(
- *   pipe(none(), match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
+ *   pipe(Option.none(), Option.match({ onNone: () => 'a none', onSome: (a) => `a some containing ${a}` })),
  *   'a none'
  * )
  *
@@ -190,12 +189,12 @@ export declare const match: {
  * This function ensures that a type guard definition is type-safe.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * const parsePositive = (n: number): O.Option<number> =>
- *   n > 0 ? O.some(n) : O.none()
+ * const parsePositive = (n: number): Option.Option<number> =>
+ *   n > 0 ? Option.some(n) : Option.none()
  *
- * const isPositive = O.toRefinement(parsePositive)
+ * const isPositive = Option.toRefinement(parsePositive)
  *
  * assert.deepStrictEqual(isPositive(1), true)
  * assert.deepStrictEqual(isPositive(-1), false)
@@ -211,10 +210,10 @@ export declare const toRefinement: <A, B extends A>(f: (a: A) => Option<B>) => (
  * @param collection - The `Iterable` to be converted to an `Option`.
  *
  * @example
- * import { fromIterable, some, none } from 'effect/Option'
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(fromIterable([1, 2, 3]), some(1))
- * assert.deepStrictEqual(fromIterable([]), none())
+ * assert.deepStrictEqual(Option.fromIterable([1, 2, 3]), Option.some(1))
+ * assert.deepStrictEqual(Option.fromIterable([]), Option.none())
  *
  * @category constructors
  * @since 2.0.0
@@ -226,11 +225,10 @@ export declare const fromIterable: <A>(collection: Iterable<A>) => Option<A>;
  * Alias of {@link fromEither}.
  *
  * @example
- * import * as O from "effect/Option"
- * import * as E from "effect/Either"
+ * import { Option, Either } from "effect"
  *
- * assert.deepStrictEqual(O.getRight(E.right('ok')), O.some('ok'))
- * assert.deepStrictEqual(O.getRight(E.left('err')), O.none())
+ * 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
@@ -240,11 +238,10 @@ export declare const getRight: <R, L>(self: Either<R, L>) => Option<R>;
  * Converts a `Either` to an `Option` discarding the value.
  *
  * @example
- * import * as O from "effect/Option"
- * import * as E from "effect/Either"
+ * import { Option, Either } from "effect"
  *
- * assert.deepStrictEqual(O.getLeft(E.right("ok")), O.none())
- * assert.deepStrictEqual(O.getLeft(E.left("a")), O.some("a"))
+ * 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
@@ -257,11 +254,10 @@ 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
- * import { some, none, getOrElse } from 'effect/Option'
- * import { pipe } from "effect/Function"
+ * import { pipe, Option } from "effect"
  *
- * assert.deepStrictEqual(pipe(some(1), getOrElse(() => 0)), 1)
- * assert.deepStrictEqual(pipe(none(), getOrElse(() => 0)), 0)
+ * 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
@@ -277,36 +273,35 @@ export declare const getOrElse: {
  * @param that - The `Option` to return if `self` is `None`.
  *
  * @example
- * import * as O from "effect/Option"
- * import { pipe } from "effect/Function"
+ * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(
  *   pipe(
- *     O.none(),
- *     O.orElse(() => O.none())
+ *     Option.none(),
+ *     Option.orElse(() => Option.none())
  *   ),
- *   O.none()
+ *   Option.none()
  * )
  * assert.deepStrictEqual(
  *   pipe(
- *     O.some('a'),
- *     O.orElse(() => O.none())
+ *     Option.some('a'),
+ *     Option.orElse(() => Option.none())
  *   ),
- *   O.some('a')
+ *   Option.some('a')
  * )
  * assert.deepStrictEqual(
  *   pipe(
- *     O.none(),
- *     O.orElse(() => O.some('b'))
+ *     Option.none(),
+ *     Option.orElse(() => Option.some('b'))
  *   ),
- *   O.some('b')
+ *   Option.some('b')
  * )
  * assert.deepStrictEqual(
  *   pipe(
- *     O.some('a'),
- *     O.orElse(() => O.some('b'))
+ *     Option.some('a'),
+ *     Option.orElse(() => Option.some('b'))
  *   ),
- *   O.some('a')
+ *   Option.some('a')
  * )
  *
  * @category error handling
@@ -323,22 +318,21 @@ export declare const orElse: {
  * @param onNone - Function that returns the default value to return if the `Option` is `None`.
  *
  * @example
- * import * as O from "effect/Option"
- * import { pipe } from "effect/Function"
+ * import { pipe, Option } from "effect"
  *
  * assert.deepStrictEqual(
  *   pipe(
- *     O.none(),
- *     O.orElseSome(() => 'b')
+ *     Option.none(),
+ *     Option.orElseSome(() => 'b')
  *   ),
- *   O.some('b')
+ *   Option.some('b')
  * )
  * assert.deepStrictEqual(
  *   pipe(
- *     O.some('a'),
- *     O.orElseSome(() => 'b')
+ *     Option.some('a'),
+ *     Option.orElseSome(() => 'b')
  *   ),
- *   O.some('a')
+ *   Option.some('a')
  * )
  *
  * @category error handling
@@ -370,9 +364,9 @@ export declare const orElseEither: {
  * @param collection - An iterable collection of `Option` to be searched.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(O.firstSomeOf([O.none(), O.some(1), O.some(2)]), O.some(1))
+ * assert.deepStrictEqual(Option.firstSomeOf([Option.none(), Option.some(1), Option.some(2)]), Option.some(1))
  *
  * @category error handling
  * @since 2.0.0
@@ -385,11 +379,11 @@ export declare const firstSomeOf: <A>(collection: Iterable<Option<A>>) => Option
  * @param nullableValue - The nullable value to be converted to an `Option`.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(O.fromNullable(undefined), O.none())
- * assert.deepStrictEqual(O.fromNullable(null), O.none())
- * assert.deepStrictEqual(O.fromNullable(1), O.some(1))
+ * 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
@@ -399,17 +393,17 @@ 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
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
  * const parse = (s: string): number | undefined => {
  *   const n = parseFloat(s)
  *   return isNaN(n) ? undefined : n
  * }
  *
- * const parseOption = O.liftNullable(parse)
+ * const parseOption = Option.liftNullable(parse)
  *
- * assert.deepStrictEqual(parseOption('1'), O.some(1))
- * assert.deepStrictEqual(parseOption('not a number'), O.none())
+ * assert.deepStrictEqual(parseOption('1'), Option.some(1))
+ * assert.deepStrictEqual(parseOption('not a number'), Option.none())
  *
  * @category conversions
  * @since 2.0.0
@@ -421,10 +415,10 @@ export declare const liftNullable: <A extends readonly unknown[], B>(f: (...a: A
  * @param self - The `Option` to extract the value from.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(O.getOrNull(O.some(1)), 1)
- * assert.deepStrictEqual(O.getOrNull(O.none()), null)
+ * assert.deepStrictEqual(Option.getOrNull(Option.some(1)), 1)
+ * assert.deepStrictEqual(Option.getOrNull(Option.none()), null)
  *
  * @category getters
  * @since 2.0.0
@@ -436,10 +430,10 @@ export declare const getOrNull: <A>(self: Option<A>) => A | null;
  * @param self - The `Option` to extract the value from.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(O.getOrUndefined(O.some(1)), 1)
- * assert.deepStrictEqual(O.getOrUndefined(O.none()), undefined)
+ * assert.deepStrictEqual(Option.getOrUndefined(Option.some(1)), 1)
+ * assert.deepStrictEqual(Option.getOrUndefined(Option.none()), undefined)
  *
  * @category getters
  * @since 2.0.0
@@ -454,12 +448,12 @@ export declare const getOrUndefined: <A>(self: Option<A>) => A | undefined;
  * @param f - the function that can throw exceptions.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * const parse = O.liftThrowable(JSON.parse)
+ * const parse = Option.liftThrowable(JSON.parse)
  *
- * assert.deepStrictEqual(parse("1"), O.some(1))
- * assert.deepStrictEqual(parse(""), O.none())
+ * assert.deepStrictEqual(parse("1"), Option.some(1))
+ * assert.deepStrictEqual(parse(""), Option.none())
  *
  * @category conversions
  * @since 2.0.0
@@ -474,13 +468,13 @@ export declare const liftThrowable: <A extends readonly unknown[], B>(f: (...a:
  * @param onNone - A function that will be called if the `Option` is `None`. It returns the error to be thrown.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
  * assert.deepStrictEqual(
- *   O.getOrThrowWith(O.some(1), () => new Error('Unexpected None')),
+ *   Option.getOrThrowWith(Option.some(1), () => new Error('Unexpected None')),
  *   1
  * )
- * assert.throws(() => O.getOrThrowWith(O.none(), () => new Error('Unexpected None')))
+ * assert.throws(() => Option.getOrThrowWith(Option.none(), () => new Error('Unexpected None')))
  *
  * @category conversions
  * @since 2.0.0
@@ -498,10 +492,10 @@ export declare const getOrThrowWith: {
  * @throws `Error("getOrThrow called on a None")`
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(O.getOrThrow(O.some(1)), 1)
- * assert.throws(() => O.getOrThrow(O.none()))
+ * assert.deepStrictEqual(Option.getOrThrow(Option.some(1)), 1)
+ * assert.throws(() => Option.getOrThrow(Option.none()))
  *
  * @category conversions
  * @since 2.0.0
@@ -574,8 +568,7 @@ export declare const andThen: {
  * This is `flatMap` + `fromNullable`, useful when working with optional values.
  *
  * @example
- * import { some, none, flatMapNullable } from 'effect/Option'
- * import { pipe } from "effect/Function"
+ * import { pipe, Option } from "effect"
  *
  * interface Employee {
  *   company?: {
@@ -591,20 +584,20 @@ export declare const andThen: {
  *
  * assert.deepStrictEqual(
  *   pipe(
- *     some(employee1),
- *     flatMapNullable(employee => employee.company?.address?.street?.name),
+ *     Option.some(employee1),
+ *     Option.flatMapNullable(employee => employee.company?.address?.street?.name),
  *   ),
- *   some('high street')
+ *   Option.some('high street')
  * )
  *
  * const employee2: Employee = { company: { address: { street: {} } } }
  *
  * assert.deepStrictEqual(
  *   pipe(
- *     some(employee2),
- *     flatMapNullable(employee => employee.company?.address?.street?.name),
+ *     Option.some(employee2),
+ *     Option.flatMapNullable(employee => employee.company?.address?.street?.name),
  *   ),
- *   none()
+ *   Option.none()
  * )
  *
  * @category sequencing
@@ -660,13 +653,13 @@ export declare const zipLeft: {
  * @param self - The `Option` to apply the function to
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * const getInteger = (n: number) => Number.isInteger(n) ? O.some(n) : O.none()
+ * const getInteger = (n: number) => Number.isInteger(n) ? Option.some(n) : Option.none()
  *
- * assert.deepStrictEqual(O.tap(O.none(), getInteger), O.none())
- * assert.deepStrictEqual(O.tap(O.some(1), getInteger), O.some(1))
- * assert.deepStrictEqual(O.tap(O.some(1.14), getInteger), O.none())
+ * 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
@@ -695,11 +688,11 @@ export declare const productMany: <A>(self: Option<A>, collection: Iterable<Opti
  * @param fields - the struct of `Option`s to be sequenced.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(O.all([O.some(1), O.some(2)]), O.some([1, 2]))
- * assert.deepStrictEqual(O.all({ a: O.some(1), b: O.some("hello") }), O.some({ a: 1, b: "hello" }))
- * assert.deepStrictEqual(O.all({ a: O.some(1), b: O.none() }), O.none())
+ * 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
@@ -717,18 +710,18 @@ 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
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
  * type Complex = [real: number, imaginary: number]
  *
  * const complex = (real: number, imaginary: number): Complex => [real, imaginary]
  *
- * assert.deepStrictEqual(O.zipWith(O.none(), O.none(), complex), O.none())
- * assert.deepStrictEqual(O.zipWith(O.some(1), O.none(), complex), O.none())
- * assert.deepStrictEqual(O.zipWith(O.none(), O.some(1), complex), O.none())
- * assert.deepStrictEqual(O.zipWith(O.some(1), O.some(2), complex), O.some([1, 2]))
+ * assert.deepStrictEqual(Option.zipWith(Option.none(), Option.none(), complex), Option.none())
+ * assert.deepStrictEqual(Option.zipWith(Option.some(1), Option.none(), complex), Option.none())
+ * assert.deepStrictEqual(Option.zipWith(Option.none(), Option.some(1), complex), Option.none())
+ * assert.deepStrictEqual(Option.zipWith(Option.some(1), Option.some(2), complex), Option.some([1, 2]))
  *
- * assert.deepStrictEqual(O.zipWith(O.some(1), complex)(O.some(2)), O.some([2, 1]))
+ * assert.deepStrictEqual(Option.zipWith(Option.some(1), complex)(Option.some(2)), Option.some([2, 1]))
  *
  * @category zipping
  * @since 2.0.0
@@ -753,11 +746,10 @@ export declare const ap: {
  * @param f - The reducing function that takes the current accumulator value and the unwrapped value of an `Option<A>`.
  *
  * @example
- * import { some, none, reduceCompact } from 'effect/Option'
- * import { pipe } from "effect/Function"
+ * import { pipe, Option } from "effect"
  *
- * const iterable = [some(1), none(), some(2), none()]
- * assert.deepStrictEqual(pipe(iterable, reduceCompact(0, (b, a) => b + a)), 3)
+ * 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
@@ -774,10 +766,10 @@ export declare const reduceCompact: {
  * @param self - The `Option` to convert to an array.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * assert.deepStrictEqual(O.toArray(O.some(1)), [1])
- * assert.deepStrictEqual(O.toArray(O.none()), [])
+ * assert.deepStrictEqual(Option.toArray(Option.some(1)), [1])
+ * assert.deepStrictEqual(Option.toArray(Option.none()), [])
  *
  * @category conversions
  * @since 2.0.0
@@ -800,13 +792,13 @@ export declare const partitionMap: {
  * @param f - A function to apply to the value of the `Option`.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * const evenNumber = (n: number) => n % 2 === 0 ? O.some(n) : O.none()
+ * const evenNumber = (n: number) => n % 2 === 0 ? Option.some(n) : Option.none()
  *
- * assert.deepStrictEqual(O.filterMap(O.none(), evenNumber), O.none())
- * assert.deepStrictEqual(O.filterMap(O.some(3), evenNumber), O.none())
- * assert.deepStrictEqual(O.filterMap(O.some(2), evenNumber), O.some(2))
+ * 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
@@ -824,21 +816,21 @@ export declare const filterMap: {
  * @param fb - The `Option` to filter.
  *
  * @example
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
  * // predicate
  * const isEven = (n: number) => n % 2 === 0
  *
- * assert.deepStrictEqual(O.filter(O.none(), isEven), O.none())
- * assert.deepStrictEqual(O.filter(O.some(3), isEven), O.none())
- * assert.deepStrictEqual(O.filter(O.some(2), isEven), O.some(2))
+ * assert.deepStrictEqual(Option.filter(Option.none(), isEven), Option.none())
+ * assert.deepStrictEqual(Option.filter(Option.some(3), isEven), Option.none())
+ * assert.deepStrictEqual(Option.filter(Option.some(2), isEven), Option.some(2))
  *
  * // refinement
  * const isNumber = (v: unknown): v is number => typeof v === "number"
  *
- * assert.deepStrictEqual(O.filter(O.none(), isNumber), O.none())
- * assert.deepStrictEqual(O.filter(O.some('hello'), isNumber), O.none())
- * assert.deepStrictEqual(O.filter(O.some(2), isNumber), O.some(2))
+ * 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
@@ -851,15 +843,14 @@ export declare const filter: {
 };
 /**
  * @example
- * import { none, some, getEquivalence } from 'effect/Option'
- * import * as N from 'effect/Number'
+ * import { Option, Number } from "effect"
  *
- * const isEquivalent = getEquivalence(N.Equivalence)
- * assert.deepStrictEqual(isEquivalent(none(), none()), true)
- * assert.deepStrictEqual(isEquivalent(none(), some(1)), false)
- * assert.deepStrictEqual(isEquivalent(some(1), none()), false)
- * assert.deepStrictEqual(isEquivalent(some(1), some(2)), false)
- * assert.deepStrictEqual(isEquivalent(some(1), some(1)), true)
+ * const isEquivalent = Option.getEquivalence(Number.Equivalence)
+ * assert.deepStrictEqual(isEquivalent(Option.none(), Option.none()), true)
+ * assert.deepStrictEqual(isEquivalent(Option.none(), Option.some(1)), false)
+ * 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
@@ -873,16 +864,14 @@ export declare const getEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A
  * `None` is considered to be less than any `Some` value.
  *
  * @example
- * import { none, some, getOrder } from 'effect/Option'
- * import * as N from 'effect/Number'
- * import { pipe } from "effect/Function"
+ * import { pipe, Option, Number } from "effect"
  *
- * const O = getOrder(N.Order)
- * assert.deepStrictEqual(O(none(), none()), 0)
- * assert.deepStrictEqual(O(none(), some(1)), -1)
- * assert.deepStrictEqual(O(some(1), none()), 1)
- * assert.deepStrictEqual(O(some(1), some(2)), -1)
- * assert.deepStrictEqual(O(some(1), some(1)), 0)
+ * const O = Option.getOrder(Number.Order)
+ * assert.deepStrictEqual(O(Option.none(), Option.none()), 0)
+ * assert.deepStrictEqual(O(Option.none(), Option.some(1)), -1)
+ * 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
@@ -907,12 +896,12 @@ 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
- * import * as O from "effect/Option"
+ * import { Option } from "effect"
  *
- * const getOption = O.liftPredicate((n: number) => n >= 0)
+ * const getOption = Option.liftPredicate((n: number) => n >= 0)
  *
- * assert.deepStrictEqual(getOption(-1), O.none())
- * assert.deepStrictEqual(getOption(1), O.some(1))
+ * assert.deepStrictEqual(getOption(-1), Option.none())
+ * assert.deepStrictEqual(getOption(1), Option.some(1))
  *
  * @category lifting
  * @since 2.0.0
@@ -929,13 +918,11 @@ export declare const liftPredicate: {
  * @param a - The value to compare against the `Option`.
  *
  * @example
- * import { some, none, containsWith } from 'effect/Option'
- * import { Equivalence } from 'effect/Number'
- * import { pipe } from "effect/Function"
+ * import { pipe, Option, Number } from "effect"
  *
- * assert.deepStrictEqual(pipe(some(2), containsWith(Equivalence)(2)), true)
- * assert.deepStrictEqual(pipe(some(1), containsWith(Equivalence)(2)), false)
- * assert.deepStrictEqual(pipe(none(), containsWith(Equivalence)(2)), false)
+ * 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
@@ -961,14 +948,13 @@ export declare const contains: {
  * @param predicate - The condition to check.
  *
  * @example
- * import { some, none, exists } from 'effect/Option'
- * import { pipe } from "effect/Function"
+ * import { pipe, Option } from "effect"
  *
  * const isEven = (n: number) => n % 2 === 0
  *
- * assert.deepStrictEqual(pipe(some(2), exists(isEven)), true)
- * assert.deepStrictEqual(pipe(some(1), exists(isEven)), false)
- * assert.deepStrictEqual(pipe(none(), exists(isEven)), false)
+ * 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
  */
@@ -979,6 +965,32 @@ export declare const exists: {
     <A>(self: Option<A>, predicate: Predicate<A>): boolean;
 };
 /**
+ * The "do simulation" in allows you to write code in a more declarative style, similar to the "do notation" in other programming languages. It provides a way to define variables and perform operations on them using functions like `bind` and `let`.
+ *
+ * Here's how the do simulation works:
+ *
+ * 1. Start the do simulation using the `Do` value
+ * 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Option` values
+ * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
+ * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
+ * 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
+ *
+ * @see {@link Do}
+ * @see {@link bind}
+ * @see {@link let_ let}
+ *
+ * @example
+ * import { Option, pipe } from "effect"
+ *
+ * const result = pipe(
+ *   Option.Do,
+ *   Option.bind("x", () => Option.some(2)),
+ *   Option.bind("y", () => Option.some(3)),
+ *   Option.let("sum", ({ x, y }) => x + y),
+ *   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
  */
@@ -1000,11 +1012,63 @@ declare const let_: {
 };
 export { 
 /**
+ * The "do simulation" in allows you to write code in a more declarative style, similar to the "do notation" in other programming languages. It provides a way to define variables and perform operations on them using functions like `bind` and `let`.
+ *
+ * Here's how the do simulation works:
+ *
+ * 1. Start the do simulation using the `Do` value
+ * 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Option` values
+ * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
+ * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
+ * 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
+ *
+ * @see {@link Do}
+ * @see {@link bind}
+ * @see {@link bindTo}
+ *
+ * @example
+ * import { Option, pipe } from "effect"
+ *
+ * const result = pipe(
+ *   Option.Do,
+ *   Option.bind("x", () => Option.some(2)),
+ *   Option.bind("y", () => Option.some(3)),
+ *   Option.let("sum", ({ x, y }) => x + y),
+ *   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
  */
 let_ as let };
 /**
+ * The "do simulation" in allows you to write code in a more declarative style, similar to the "do notation" in other programming languages. It provides a way to define variables and perform operations on them using functions like `bind` and `let`.
+ *
+ * Here's how the do simulation works:
+ *
+ * 1. Start the do simulation using the `Do` value
+ * 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Option` values
+ * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
+ * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
+ * 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
+ *
+ * @see {@link Do}
+ * @see {@link bindTo}
+ * @see {@link let_ let}
+ *
+ * @example
+ * import { Option, pipe } from "effect"
+ *
+ * const result = pipe(
+ *   Option.Do,
+ *   Option.bind("x", () => Option.some(2)),
+ *   Option.bind("y", () => Option.some(3)),
+ *   Option.let("sum", ({ x, y }) => x + y),
+ *   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
  */
@@ -1017,6 +1081,32 @@ export declare const bind: {
     }>;
 };
 /**
+ * The "do simulation" in allows you to write code in a more declarative style, similar to the "do notation" in other programming languages. It provides a way to define variables and perform operations on them using functions like `bind` and `let`.
+ *
+ * Here's how the do simulation works:
+ *
+ * 1. Start the do simulation using the `Do` value
+ * 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Option` values
+ * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
+ * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
+ * 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
+ *
+ * @see {@link bindTo}
+ * @see {@link bind}
+ * @see {@link let_ let}
+ *
+ * @example
+ * import { Option, pipe } from "effect"
+ *
+ * const result = pipe(
+ *   Option.Do,
+ *   Option.bind("x", () => Option.some(2)),
+ *   Option.bind("y", () => Option.some(3)),
+ *   Option.let("sum", ({ x, y }) => x + y),
+ *   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
  */